DocumentMasterTemplate (docdoku-api-java 2.5-SNAPSHOT API)

java.lang.Object
- com.docdoku.core.document.DocumentMasterTemplate

All Implemented Interfaces:

FileHolder, Serializable, Comparable<DocumentMasterTemplate>
```
@Entity
public class DocumentMasterTemplate
extends Object
implements Serializable, FileHolder, Comparable<DocumentMasterTemplate>
```
A model object from which we can create a DocumentMaster. Creating a document through a model offers the ability to enforce an input mask for the document ID, as well insuring that the starting iteration defines some custom attributes or has some specific binary files.

Since:

V1.0

Version:

1.1, 23/01/12

Author:

Florent Garin

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DocumentMasterTemplate()`
`DocumentMasterTemplate(Workspace pWorkspace, String pId, User pAuthor, String pDocumentType, String pMask)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFile(BinaryResource pBinaryResource)`
`int`	`compareTo(DocumentMasterTemplate pTemplate)`
`boolean`	`equals(Object pObj)`
`ACL`	`getAcl()`
`Set<BinaryResource>`	`getAttachedFiles()`
`List<InstanceAttributeTemplate>`	`getAttributeTemplates()`
`User`	`getAuthor()`
`Date`	`getCreationDate()`
`String`	`getDocumentType()`
`String`	`getId()`
`DocumentMasterTemplateKey`	`getKey()`
`String`	`getMask()`
`Date`	`getModificationDate()`
`WorkflowModel`	`getWorkflowModel()`
`String`	`getWorkflowModelId()`
`Workspace`	`getWorkspace()`
`String`	`getWorkspaceId()`
`int`	`hashCode()`
`boolean`	`isAttributesLocked()`
`boolean`	`isIdGenerated()`
`boolean`	`removeFile(BinaryResource pBinaryResource)`
`void`	`setAcl(ACL acl)`
`void`	`setAttachedFiles(Set<BinaryResource> attachedFiles)`
`void`	`setAttributesLocked(boolean attributesLocked)`
`void`	`setAttributeTemplates(List<InstanceAttributeTemplate> pAttributeTemplates)`
`void`	`setAuthor(User pAuthor)`
`void`	`setCreationDate(Date pCreationDate)`
`void`	`setDocumentType(String documentType)`
`void`	`setId(String id)`
`void`	`setIdGenerated(boolean idGenerated)`
`void`	`setMask(String pMask)`
`void`	`setModificationDate(Date modificationDate)`
`void`	`setWorkflowModel(WorkflowModel workflowModel)`
`void`	`setWorkflowModelId(String workflowModelId)`
`void`	`setWorkspace(Workspace pWorkspace)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentMasterTemplate
```
public DocumentMasterTemplate()
```

DocumentMasterTemplate

public DocumentMasterTemplate(Workspace pWorkspace,
                              String pId,
                              User pAuthor,
                              String pDocumentType,
                              String pMask)

Method Detail

getDocumentType
```
public String getDocumentType()
```

setDocumentType

public void setDocumentType(String documentType)

getWorkflowModelId
```
public String getWorkflowModelId()
```

setWorkflowModelId

public void setWorkflowModelId(String workflowModelId)

getWorkflowModel

public WorkflowModel getWorkflowModel()

setWorkflowModel

public void setWorkflowModel(WorkflowModel workflowModel)

getMask
```
public String getMask()
```

setMask
```
public void setMask(String pMask)
```

setAttachedFiles

public void setAttachedFiles(Set<BinaryResource> attachedFiles)

setId
```
public void setId(String id)
```

isIdGenerated
```
public boolean isIdGenerated()
```

setIdGenerated

public void setIdGenerated(boolean idGenerated)

removeFile

public boolean removeFile(BinaryResource pBinaryResource)

addFile

public void addFile(BinaryResource pBinaryResource)

getAttachedFiles
```
public Set<BinaryResource> getAttachedFiles()
```
Specified by:

getAttachedFiles in interface FileHolder

getAttributeTemplates

public List<InstanceAttributeTemplate> getAttributeTemplates()

setAttributeTemplates

public void setAttributeTemplates(List<InstanceAttributeTemplate> pAttributeTemplates)

isAttributesLocked
```
public boolean isAttributesLocked()
```

setAttributesLocked

public void setAttributesLocked(boolean attributesLocked)

setAuthor
```
public void setAuthor(User pAuthor)
```

getAuthor
```
public User getAuthor()
```

setCreationDate

public void setCreationDate(Date pCreationDate)

getCreationDate
```
public Date getCreationDate()
```

getModificationDate
```
public Date getModificationDate()
```

setModificationDate

public void setModificationDate(Date modificationDate)

setWorkspace

public void setWorkspace(Workspace pWorkspace)

getAcl
```
public ACL getAcl()
```

setAcl
```
public void setAcl(ACL acl)
```

getWorkspace
```
public Workspace getWorkspace()
```

getId
```
public String getId()
```

getWorkspaceId
```
public String getWorkspaceId()
```

getKey

public DocumentMasterTemplateKey getKey()

equals
```
public boolean equals(Object pObj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

compareTo
```
public int compareTo(DocumentMasterTemplate pTemplate)
```
Specified by:

compareTo in interface Comparable<DocumentMasterTemplate>

Class DocumentMasterTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentMasterTemplate

DocumentMasterTemplate

Method Detail

getDocumentType

setDocumentType

getWorkflowModelId

setWorkflowModelId

getWorkflowModel

setWorkflowModel

getMask

setMask

setAttachedFiles

setId

isIdGenerated

setIdGenerated

removeFile

addFile

getAttachedFiles

getAttributeTemplates

setAttributeTemplates

isAttributesLocked

setAttributesLocked

setAuthor

getAuthor

setCreationDate

getCreationDate

getModificationDate

setModificationDate

setWorkspace

getAcl

setAcl

getWorkspace

getId

getWorkspaceId

getKey

equals

hashCode

toString

compareTo