org.opencrx.kernel.document1.cci2.Document Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.document1.cci2;
/**
* Class {@code Document}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:35.299172327Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Document
extends org.opencrx.kernel.base.cci2.Auditee,
org.opencrx.kernel.base.cci2.Exporter,
org.opencrx.kernel.base.cci2.Importer,
org.opencrx.kernel.base.cci2.Indexed,
org.opencrx.kernel.base.cci2.SecureObject,
org.opencrx.kernel.base.cci2.UserDefined,
org.opencrx.kernel.depot1.cci2.BookingOrigin,
org.opencrx.kernel.document1.cci2.PropertySetHolder,
org.openmdx.base.cci2.BasicObject{
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code activeOn}.
* @return The possibly null value for attribute {@code activeOn}.
*/
public java.util.Date getActiveOn(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code activeOn}.
* @param activeOn The possibly null new value for attribute {@code activeOn}.
*/
public void setActiveOn(
java.util.Date activeOn
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code activeUntil}.
* @return The possibly null value for attribute {@code activeUntil}.
*/
public java.util.Date getActiveUntil(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code activeUntil}.
* @param activeUntil The possibly null new value for attribute {@code activeUntil}.
*/
public void setActiveUntil(
java.util.Date activeUntil
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code attachment}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentHasAttachment.Attachment getAttachment(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code author}.
* @return The possibly null value for attribute {@code author}.
*/
public java.lang.String getAuthor(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code author}.
* @param author The possibly null new value for attribute {@code author}.
*/
public void setAuthor(
java.lang.String author
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code cmsClass}.
* @return The possibly null value for attribute {@code cmsClass}.
*/
public java.lang.String getCmsClass(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code cmsClass}.
* @param cmsClass The possibly null new value for attribute {@code cmsClass}.
*/
public void setCmsClass(
java.lang.String cmsClass
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code cmsDefaultLanguage}.
* @return The possibly null value for attribute {@code cmsDefaultLanguage}.
*/
public java.lang.String getCmsDefaultLanguage(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code cmsDefaultLanguage}.
* @param cmsDefaultLanguage The possibly null new value for attribute {@code cmsDefaultLanguage}.
*/
public void setCmsDefaultLanguage(
java.lang.String cmsDefaultLanguage
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code cmsLanguage}.
* @return The possibly null value for attribute {@code cmsLanguage}.
*/
public java.lang.String getCmsLanguage(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code cmsLanguage}.
* @param cmsLanguage The possibly null new value for attribute {@code cmsLanguage}.
*/
public void setCmsLanguage(
java.lang.String cmsLanguage
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code cmsMeta}.
* @return The possibly null value for attribute {@code cmsMeta}.
*/
public java.lang.String getCmsMeta(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code cmsMeta}.
* @param cmsMeta The possibly null new value for attribute {@code cmsMeta}.
*/
public void setCmsMeta(
java.lang.String cmsMeta
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code cmsTemplate}.
* @return The possibly null value for attribute {@code cmsTemplate}.
*/
public java.lang.String getCmsTemplate(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code cmsTemplate}.
* @param cmsTemplate The possibly null new value for attribute {@code cmsTemplate}.
*/
public void setCmsTemplate(
java.lang.String cmsTemplate
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code cmsTranslation}.
* @return The possibly null value for attribute {@code cmsTranslation}.
*/
public java.lang.Integer getCmsTranslation(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code cmsTranslation}.
* @param cmsTranslation The possibly null new value for attribute {@code cmsTranslation}.
*/
public void setCmsTranslation(
java.lang.Integer cmsTranslation
);
// ----------------------------------------------------------------------------
// Instance/AttributeGetList
// ----------------------------------------------------------------------------
/**
* Retrieves a list containing all the elements for the attribute {@code contentLanguage}.
* @return A list containing all elements for this attribute.
*/
public java.util.List getContentLanguage(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSetList
// ----------------------------------------------------------------------------
/**
* Clears {@code contentLanguage} and adds the given value(s).
*
* This method is equivalent to
* list.clear();
* for(short e : contentLanguage){
* list.add(e);
* }
*
* @param contentLanguage value(s) to be added to {@code contentLanguage}
*/
public void setContentLanguage(
short... contentLanguage
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code contentLength}.
* @return The possibly null value for attribute {@code contentLength}.
*/
public java.lang.Integer getContentLength(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code contentLength}.
* @param contentLength The possibly null new value for attribute {@code contentLength}.
*/
public void setContentLength(
java.lang.Integer contentLength
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code contentType}.
* @return The possibly null value for attribute {@code contentType}.
*/
public java.lang.String getContentType(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code contentType}.
* @param contentType The possibly null new value for attribute {@code contentType}.
*/
public void setContentType(
java.lang.String contentType
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code description}.
* @return The possibly null value for attribute {@code description}.
*/
public java.lang.String getDescription(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code description}.
* @param description The possibly null new value for attribute {@code description}.
*/
public void setDescription(
java.lang.String description
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code disabled}.
* @return The possibly null value for attribute {@code disabled}.
*/
public java.lang.Boolean isDisabled(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code disabled}.
* @param disabled The possibly null new value for attribute {@code disabled}.
*/
public void setDisabled(
java.lang.Boolean disabled
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code documentAbstract}.
* @return The possibly null value for attribute {@code documentAbstract}.
*/
public java.lang.String getDocumentAbstract(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code documentAbstract}.
* @param documentAbstract The possibly null new value for attribute {@code documentAbstract}.
*/
public void setDocumentAbstract(
java.lang.String documentAbstract
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code documentFolderAssignment}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentHasDocumentFolderAssignment.DocumentFolderAssignment getDocumentFolderAssignment(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code documentNumber}.
* @return The possibly null value for attribute {@code documentNumber}.
*/
public java.lang.String getDocumentNumber(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code documentNumber}.
* @param documentNumber The possibly null new value for attribute {@code documentNumber}.
*/
public void setDocumentNumber(
java.lang.String documentNumber
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code documentReference}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentHasDocumentReference.DocumentReference getDocumentReference(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentSchema}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentSchema getDocumentSchema(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code documentSchema}.
* @param documentSchema The new—possibly {@code null}—value for this reference.
*/
public void setDocumentSchema(
org.opencrx.kernel.document1.cci2.DocumentSchema documentSchema
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code documentState}.
*
* DS_ACTIVE 0 The account is active.
* DS_INACTIVE 1 The account is inactive.
*
* @return The non-null value for attribute {@code documentState}.
*/
public short getDocumentState(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code documentState}.
*
* DS_ACTIVE 0 The account is active.
* DS_INACTIVE 1 The account is inactive.
*
* @param documentState The non-{@code null} new value for attribute {@code documentState}.
*/
public void setDocumentState(
short documentState
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code documentType}.
*
* 0 - EMail
* 1 - CompanyInfo
* 2 - ProductInfo
* 3 - News
*
* @return The non-null value for attribute {@code documentType}.
*/
public short getDocumentType(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code documentType}.
*
* 0 - EMail
* 1 - CompanyInfo
* 2 - ProductInfo
* 3 - News
*
* @param documentType The non-{@code null} new value for attribute {@code documentType}.
*/
public void setDocumentType(
short documentType
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nNoQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the {@code Collection} of objects referenced by {@code folder}.
* @return The {@code Collection} of referenced objects.
*/
public java.util.List getFolder(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code headRevision}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentRevision getHeadRevision(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code headRevision}.
* @param headRevision The new—possibly {@code null}—value for this reference.
*/
public void setHeadRevision(
org.opencrx.kernel.document1.cci2.DocumentRevision headRevision
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code keywords}.
* @return The possibly null value for attribute {@code keywords}.
*/
public java.lang.String getKeywords(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code keywords}.
* @param keywords The possibly null new value for attribute {@code keywords}.
*/
public void setKeywords(
java.lang.String keywords
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code link}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentContainsLink.Link getLink(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code linkTo}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentContainsDocumentLinkTo.LinkTo getLinkTo(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code literatureType}.
* @return The non-null value for attribute {@code literatureType}.
*/
public short getLiteratureType(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code literatureType}.
* @param literatureType The non-{@code null} new value for attribute {@code literatureType}.
*/
public void setLiteratureType(
short literatureType
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code location}.
* @return The possibly null value for attribute {@code location}.
*/
public java.lang.String getLocation(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code location}.
* @param location The possibly null new value for attribute {@code location}.
*/
public void setLocation(
java.lang.String location
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code lock}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentHasLocks.Lock getLock(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code name}.
* @return The non-null value for attribute {@code name}.
*/
public java.lang.String getName(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code name}.
* @param name The non-{@code null} new value for attribute {@code name}.
*/
public void setName(
java.lang.String name
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code parent}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.document1.cci2.Document getParent(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code parent}.
* @param parent The new—possibly {@code null}—value for this reference.
*/
public void setParent(
org.opencrx.kernel.document1.cci2.Document parent
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code qualifiedName}.
* @return The possibly null value for attribute {@code qualifiedName}.
*/
public java.lang.String getQualifiedName(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code qualifiedName}.
* @param qualifiedName The possibly null new value for attribute {@code qualifiedName}.
*/
public void setQualifiedName(
java.lang.String qualifiedName
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code revision}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentHasRevision.Revision getRevision(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code searchText}.
* @return The possibly null value for attribute {@code searchText}.
*/
public java.lang.String getSearchText(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code searchText}.
* @param searchText The possibly null new value for attribute {@code searchText}.
*/
public void setSearchText(
java.lang.String searchText
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code title}.
* @return The possibly null value for attribute {@code title}.
*/
public java.lang.String getTitle(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code title}.
* @param title The possibly null new value for attribute {@code title}.
*/
public void setTitle(
java.lang.String title
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.document1.cci2.ValidateSchemaResult validateSchema(
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
/**
* Object Identity
*/
public interface Identity extends org.oasisopen.cci2.Identity {
/**
* Retrieve the {@code Segment}'s identity
* @return the parent object's identity
*/
public org.openmdx.base.cci2.Segment.Identity getSegment();
/**
* Tells whether the {@code id} value is persistent or reassignable.
* @return {@code PERSISTENT} or {@code REASSIGNABLE}
*/
public org.oasisopen.cci2.QualifierType getIdType();
/**
* The {@code id} value
* @return the {@code id} value
*/
public java.lang.String getId();
}
}