org.turro.attach.entity.EntityDocumentation Class Reference

Inheritance diagram for org.turro.attach.entity.EntityDocumentation:

Collaboration diagram for org.turro.attach.entity.EntityDocumentation:

Public Member Functions
String	getEntityPath ()
void	setEntityPath (String entityPath)
String	getContactId ()
void	setContactId (String contactId)
String	getDocumentation ()
void	setDocumentation (String documentation)
String	getRequesterId ()
void	setRequesterId (String requesterId)
EntityDocumentationStatus	getStatus ()
void	setStatus (EntityDocumentationStatus status)
String	getComment ()
void	setComment (String comment)
Date	getDeadline ()
void	setDeadline (Date deadline)
Set< String >	getAssistantIds ()
void	setAssistantIds (Set< String > assistantIds)
boolean	isValid (List< EntityDocumentation > invalids)
void	reviewStatus ()
boolean	allowsUpload () throws IOException
boolean	allowsValidation ()
boolean	allowsDeny ()
boolean	allowsDelete () throws IOException
boolean	allowsDeleteDef () throws IOException
List< Document >	getDocuments ()
Folder	getFolder ()
String	getFolderString ()
DocumentDefinition	getDefinition ()
IElephantEntity	getEntity ()
IContact	getContact ()
IContact	getRequester ()
List< IContact >	getAssistants ()

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 54 of file EntityDocumentation.java.

Member Function Documentation

allowsDelete()

boolean org.turro.attach.entity.EntityDocumentation.allowsDelete

(

)

throws IOException

Definition at line 167 of file EntityDocumentation.java.

                                                   {
    return !(getDefinition().isUploadControl() || EntityDocumentationStatus.VALIDATED.equals(status)) ||
           Authentication.isAdministrator();
  }

Here is the call graph for this function:

allowsDeleteDef()

boolean org.turro.attach.entity.EntityDocumentation.allowsDeleteDef

(

)

throws IOException

Definition at line 172 of file EntityDocumentation.java.

                                                      {
    return getFolder().isEmpty() || Authentication.isAdministrator();
  }

Here is the call graph for this function:

allowsDeny()

boolean org.turro.attach.entity.EntityDocumentation.allowsDeny

(

)

Definition at line 162 of file EntityDocumentation.java.

                              {
    return allowsValidation() || (Authentication.isAdministrator() && 
            EntityDocumentationStatus.VALIDATED.equals(status));
  }

Here is the call graph for this function:

allowsUpload()

boolean org.turro.attach.entity.EntityDocumentation.allowsUpload

(

)

throws IOException

Definition at line 152 of file EntityDocumentation.java.

                                                   {
    return (!EntityDocumentationStatus.VALIDATED.equals(status) &&
            (getDefinition().isUploadControl() || getFolder().count() < getDefinition().getMax())) ||
            Authentication.isAdministrator();
  }

Here is the call graph for this function:

allowsValidation()

boolean org.turro.attach.entity.EntityDocumentation.allowsValidation

(

)

Definition at line 158 of file EntityDocumentation.java.

                                    {
    return EntityDocumentationStatus.PENDING_VALIDATION.equals(status);
  }

getAssistantIds()

Set<String> org.turro.attach.entity.EntityDocumentation.getAssistantIds

(

)

Definition at line 126 of file EntityDocumentation.java.

                                       {
    return assistantIds;
  }

getAssistants()

List<IContact> org.turro.attach.entity.EntityDocumentation.getAssistants

(

)

Definition at line 212 of file EntityDocumentation.java.

                                        {
    return assistantIds.stream().map(id -> Contacts.getContactById(id)).toList();
  }

Here is the call graph for this function:

getComment()

String org.turro.attach.entity.EntityDocumentation.getComment

(

)

Definition at line 110 of file EntityDocumentation.java.

                             {
    return comment;
  }

Here is the caller graph for this function:

getContact()

IContact org.turro.attach.entity.EntityDocumentation.getContact

(

)

Definition at line 204 of file EntityDocumentation.java.

                               {
    return Contacts.getContactById(contactId);
  }

Here is the call graph for this function:

getContactId()

String org.turro.attach.entity.EntityDocumentation.getContactId

(

)

Definition at line 78 of file EntityDocumentation.java.

                               {
    return contactId;
  }

getDeadline()

Date org.turro.attach.entity.EntityDocumentation.getDeadline

(

)

Definition at line 118 of file EntityDocumentation.java.

                            {
    return deadline;
  }

getDefinition()

DocumentDefinition org.turro.attach.entity.EntityDocumentation.getDefinition

(

)

Definition at line 196 of file EntityDocumentation.java.

                                            {
    return DocumentDefinitions.instance().get(documentation);
  }

Here is the call graph for this function:

getDocumentation()

String org.turro.attach.entity.EntityDocumentation.getDocumentation

(

)

Definition at line 86 of file EntityDocumentation.java.

                                   {
    return documentation;
  }

getDocuments()

List<Document> org.turro.attach.entity.EntityDocumentation.getDocuments

(

)

Definition at line 176 of file EntityDocumentation.java.

                                       {
    Folder folder = getFolder();
    if(folder.exists()) try {
      return folder.documents();
    } catch (IOException ex) {
      Logger.getLogger(EntityDocumentation.class.getName()).log(Level.SEVERE, null, ex);
    }
    return Collections.EMPTY_LIST;
  }

getEntity()

IElephantEntity org.turro.attach.entity.EntityDocumentation.getEntity

(

)

Definition at line 200 of file EntityDocumentation.java.

                                     {
    return Entities.getController(entityPath);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getEntityPath()

String org.turro.attach.entity.EntityDocumentation.getEntityPath

(

)

Definition at line 70 of file EntityDocumentation.java.

                                {
    return entityPath;
  }

getFolder()

Folder org.turro.attach.entity.EntityDocumentation.getFolder

(

)

Definition at line 186 of file EntityDocumentation.java.

                            {
    return Folder.from(ElephantContext.getRealPath(getFolderString()));
  }

Here is the call graph for this function:

getFolderString()

String org.turro.attach.entity.EntityDocumentation.getFolderString

(

)

Definition at line 190 of file EntityDocumentation.java.

                                  {
    DocumentDefinition dd = getDefinition();
    return "/WEB-INF/files/" + entityPath + "/documentation/" + 
            dd.getFolderName() + "/" + contactId;
  }

Here is the call graph for this function:

getRequester()

IContact org.turro.attach.entity.EntityDocumentation.getRequester

(

)

Definition at line 208 of file EntityDocumentation.java.

                                 {
    return Contacts.getContactById(requesterId);
  }

Here is the call graph for this function:

getRequesterId()

String org.turro.attach.entity.EntityDocumentation.getRequesterId

(

)

Definition at line 94 of file EntityDocumentation.java.

                                 {
    return requesterId;
  }

getStatus()

EntityDocumentationStatus org.turro.attach.entity.EntityDocumentation.getStatus

(

)

Definition at line 102 of file EntityDocumentation.java.

                                               {
    return status;
  }

Here is the caller graph for this function:

isValid()

boolean org.turro.attach.entity.EntityDocumentation.isValid

(

List< EntityDocumentation >

invalids

)

Definition at line 136 of file EntityDocumentation.java.

                                                             {
    if(getDefinition() == null) {
      invalids.add(this);
      return false;
    }
    return true;
  }

reviewStatus()

void org.turro.attach.entity.EntityDocumentation.reviewStatus

(

)

Definition at line 144 of file EntityDocumentation.java.

                             {
    if(getFolder().count() < getDefinition().getMin()) {
      status = EntityDocumentationStatus.PENDING_UPLOAD;
    } else if(!EntityDocumentationStatus.validationStatus().contains(status)) {
      status = EntityDocumentationStatus.PENDING_VALIDATION;
    }
  }

Here is the call graph for this function:

setAssistantIds()

void org.turro.attach.entity.EntityDocumentation.setAssistantIds

(

Set< String >

assistantIds

)

Definition at line 130 of file EntityDocumentation.java.

                                                        {
    this.assistantIds = assistantIds;
  }

setComment()

void org.turro.attach.entity.EntityDocumentation.setComment

(

String

comment

)

Definition at line 114 of file EntityDocumentation.java.

                                         {
    this.comment = comment;
  }

setContactId()

void org.turro.attach.entity.EntityDocumentation.setContactId

(

String

contactId

)

Definition at line 82 of file EntityDocumentation.java.

                                             {
    this.contactId = contactId;
  }

Here is the caller graph for this function:

setDeadline()

void org.turro.attach.entity.EntityDocumentation.setDeadline

(

Date

deadline

)

Definition at line 122 of file EntityDocumentation.java.

                                         {
    this.deadline = deadline;
  }

Here is the caller graph for this function:

setDocumentation()

void org.turro.attach.entity.EntityDocumentation.setDocumentation

(

String

documentation

)

Definition at line 90 of file EntityDocumentation.java.

                                                     {
    this.documentation = documentation;
  }

Here is the caller graph for this function:

setEntityPath()

void org.turro.attach.entity.EntityDocumentation.setEntityPath

(

String

entityPath

)

Definition at line 74 of file EntityDocumentation.java.

                                               {
    this.entityPath = entityPath;
  }

Here is the caller graph for this function:

setRequesterId()

void org.turro.attach.entity.EntityDocumentation.setRequesterId

(

String

requesterId

)

Definition at line 98 of file EntityDocumentation.java.

                                                 {
    this.requesterId = requesterId;
  }

Here is the caller graph for this function:

setStatus()

void org.turro.attach.entity.EntityDocumentation.setStatus

(

EntityDocumentationStatus

status

)

Definition at line 106 of file EntityDocumentation.java.

                                                          {
    this.status = status;
  }

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• EntityDocumentation.java