public class Document
extends java.lang.Object
implements java.io.Serializable
| Modifier and Type | Class and Description |
|---|---|
static class |
Document.Comparator |
static class |
Document.PublicationStatus |
| Modifier | Constructor and Description |
|---|---|
protected |
Document(DocumentDomainObject document,
ContentManagementSystem contentManagementSystem) |
| Modifier and Type | Method and Description |
|---|---|
void |
addCategory(Category category) |
void |
addCategory(Category category)
Deprecated.
|
boolean |
equals(java.lang.Object o) |
java.lang.String |
getAlias() |
java.util.Date |
getArchivedDatetime() |
Category[] |
getCategories()
Deprecated.
|
Category[] |
getCategoriesOfType(CategoryType categoryType)
Deprecated.
|
java.util.Date |
getCreatedDatetime() |
User |
getCreator() |
RestrictedPermission |
getDocumentPermissionSetForUser() |
java.lang.String |
getHeadline() |
int |
getId() |
DocumentDomainObject |
getInternal() |
java.util.Set<java.lang.String> |
getKeywords() |
DocumentLanguage |
getLanguage() |
java.lang.String |
getMenuText() |
java.util.Date |
getModifiedDatetime() |
java.lang.String |
getName() |
Meta.Permission |
getPermissionSetIdForRole(Role role) |
DocumentPermissionSet |
getPermissionSetRestrictedOne()
Deprecated.
|
DocumentPermissionSet |
getPermissionSetRestrictedTwo()
Deprecated.
|
java.util.Date |
getPublicationEndDatetime() |
java.util.Date |
getPublicationStartDatetime() |
Document.PublicationStatus |
getPublicationStatus() |
User |
getPublisher() |
java.util.Map<Role,DocumentPermissionSet> |
getRolesMappedToPermissions()
Deprecated.
|
int |
getStatus()
Deprecated.
Use
getPublicationStatus() instead. |
java.lang.String |
getTarget() |
int |
getVersionNo() |
int |
hashCode() |
boolean |
isActive()
Whether the document is published and not archived.
|
boolean |
isArchived()
Whether the document is archived.
|
boolean |
isLinkableByOtherUsers() |
boolean |
isPublished()
Whether the document is published.
|
boolean |
isSearchDisabled() |
boolean |
isVisibleInMenusForUnauthorizedUsers() |
void |
removeCategory(Category category) |
void |
removeCategory(Category category)
Deprecated.
Use
removeCategory(com.imcode.imcms.model.Category) instead. |
void |
setAlias(java.lang.String alias) |
void |
setArchivedDatetime(java.util.Date datetime) |
void |
setCreator(User creator) |
void |
setHeadline(java.lang.String headline) |
void |
setKeywords(java.util.Set<java.lang.String> keywords) |
void |
setLinkableByOtherUsers(boolean linkableByOtherUsers) |
void |
setMenuText(java.lang.String menuText) |
void |
setModifiedDatetime(java.util.Date date) |
void |
setPermissionSetTypeForRole(Role role,
Meta.Permission permission) |
void |
setPublicationEndDatetime(java.util.Date datetime) |
void |
setPublicationStartDatetime(java.util.Date datetime) |
void |
setPublicationStatus(Document.PublicationStatus publicationStatus) |
void |
setPublisher(User user) |
void |
setSearchDisabled(boolean searchDisabled) |
void |
setStatus(int status)
Deprecated.
|
void |
setVisibleInMenusForUnauthorizedUsers(boolean visibleInMenusForUnauthorizedUsers) |
protected Document(DocumentDomainObject document, ContentManagementSystem contentManagementSystem)
public DocumentDomainObject getInternal()
public int getId()
public boolean isArchived()
public boolean isActive()
public boolean isPublished()
public boolean isSearchDisabled()
public void setSearchDisabled(boolean searchDisabled)
public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic DocumentLanguage getLanguage()
public int getVersionNo()
public int hashCode()
hashCode in class java.lang.Objectpublic java.util.Set<java.lang.String> getKeywords()
public void setKeywords(java.util.Set<java.lang.String> keywords)
public java.lang.String getHeadline()
public void setHeadline(java.lang.String headline)
public java.lang.String getMenuText()
public void setMenuText(java.lang.String menuText)
public java.lang.String getAlias()
public void setAlias(java.lang.String alias)
public java.lang.String getName()
public User getCreator()
public void setCreator(User creator)
public void addCategory(Category category)
@Deprecated public void addCategory(Category category)
public void setPermissionSetTypeForRole(Role role, Meta.Permission permission)
public Meta.Permission getPermissionSetIdForRole(Role role)
public RestrictedPermission getDocumentPermissionSetForUser()
@Deprecated public DocumentPermissionSet getPermissionSetRestrictedOne()
@Deprecated public DocumentPermissionSet getPermissionSetRestrictedTwo()
@Deprecated public java.util.Map<Role,DocumentPermissionSet> getRolesMappedToPermissions()
@Deprecated public Category[] getCategories()
public User getPublisher()
public void setPublisher(User user)
public java.lang.String getTarget()
public java.util.Date getPublicationStartDatetime()
public void setPublicationStartDatetime(java.util.Date datetime)
public java.util.Date getArchivedDatetime()
public void setArchivedDatetime(java.util.Date datetime)
public java.util.Date getModifiedDatetime()
public void setModifiedDatetime(java.util.Date date)
public java.util.Date getCreatedDatetime()
public java.util.Date getPublicationEndDatetime()
public void setPublicationEndDatetime(java.util.Date datetime)
public int getStatus()
getPublicationStatus() instead.public void setStatus(int status)
setPublicationStatus(com.imcode.imcms.api.Document.PublicationStatus) instead.public boolean isVisibleInMenusForUnauthorizedUsers()
public void setVisibleInMenusForUnauthorizedUsers(boolean visibleInMenusForUnauthorizedUsers)
public boolean isLinkableByOtherUsers()
public void setLinkableByOtherUsers(boolean linkableByOtherUsers)
public Document.PublicationStatus getPublicationStatus()
public void setPublicationStatus(Document.PublicationStatus publicationStatus)
public void removeCategory(Category category)
public void removeCategory(Category category)
removeCategory(com.imcode.imcms.model.Category) instead.@Deprecated public Category[] getCategoriesOfType(CategoryType categoryType)