org.opencrx.kernel.document1.jmi1.Document Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.document1.jmi1;
/**
* Class {@code Document}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:37.572066652Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Document
extends org.opencrx.kernel.document1.cci2.Document,
org.opencrx.kernel.base.jmi1.Auditee,
org.opencrx.kernel.base.jmi1.Exporter,
org.opencrx.kernel.base.jmi1.Importer,
org.opencrx.kernel.base.jmi1.Indexed,
org.opencrx.kernel.base.jmi1.SecureObject,
org.opencrx.kernel.base.jmi1.UserDefined,
org.opencrx.kernel.depot1.jmi1.BookingOrigin,
org.opencrx.kernel.document1.jmi1.PropertySetHolder,
org.openmdx.base.jmi1.BasicObject{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code attachment} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getAttachment(
org.opencrx.kernel.document1.cci2.DocumentAttachmentQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code attachment} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentAttachment getAttachment(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code attachment} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getAttachment(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentAttachment getAttachment(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code attachment}.
*
* Note: This is an extension to the JMI 1 standard.
* @param idIsPersistent {@code true} if {@code id} is persistent
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param attachment The element to be appended.
*/
public void addAttachment (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentAttachment attachment
);
/**
* Adds the specified element to the set of the values for the reference {@code attachment} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param attachment The element to be appended.
*/
public void addAttachment (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentAttachment attachment
);
/**
* Adds the specified element to the set of the values for the reference {@code attachment} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param attachment The element to be appended.
*/
public void addAttachment (
org.opencrx.kernel.document1.jmi1.DocumentAttachment attachment
);
// ----------------------------------------------------------------------------
// 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 members of the given List.
*
* This method is equivalent to
* list.clear();
* list.addAll(contentLanguage);
*
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the equivalent code.
* @param contentLanguage collection to be copied.
*/
public void setContentLanguage(
java.util.List contentLanguage
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentFolderAssignment} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getDocumentFolderAssignment(
org.opencrx.kernel.document1.cci2.FolderAssignmentQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentFolderAssignment} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.FolderAssignment getDocumentFolderAssignment(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code documentFolderAssignment} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getDocumentFolderAssignment(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.FolderAssignment getDocumentFolderAssignment(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code documentFolderAssignment}.
*
* Note: This is an extension to the JMI 1 standard.
* @param idIsPersistent {@code true} if {@code id} is persistent
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param documentFolderAssignment The element to be appended.
*/
public void addDocumentFolderAssignment (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.FolderAssignment documentFolderAssignment
);
/**
* Adds the specified element to the set of the values for the reference {@code documentFolderAssignment} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param documentFolderAssignment The element to be appended.
*/
public void addDocumentFolderAssignment (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.FolderAssignment documentFolderAssignment
);
/**
* Adds the specified element to the set of the values for the reference {@code documentFolderAssignment} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param documentFolderAssignment The element to be appended.
*/
public void addDocumentFolderAssignment (
org.opencrx.kernel.document1.jmi1.FolderAssignment documentFolderAssignment
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentReference} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getDocumentReference(
org.opencrx.kernel.document1.cci2.DocumentReferenceQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentReference} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentReference getDocumentReference(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code documentReference} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getDocumentReference(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentReference getDocumentReference(
java.lang.String id
);
// ----------------------------------------------------------------------------
// 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.jmi1.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/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code headRevision}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.document1.jmi1.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/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code link} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getLink(
org.opencrx.kernel.document1.cci2.DocumentLinkQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code link} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentLink getLink(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code link} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getLink(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentLink getLink(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code link}.
*
* Note: This is an extension to the JMI 1 standard.
* @param idIsPersistent {@code true} if {@code id} is persistent
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param link The element to be appended.
*/
public void addLink (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentLink link
);
/**
* Adds the specified element to the set of the values for the reference {@code link} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param link The element to be appended.
*/
public void addLink (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentLink link
);
/**
* Adds the specified element to the set of the values for the reference {@code link} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param link The element to be appended.
*/
public void addLink (
org.opencrx.kernel.document1.jmi1.DocumentLink link
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code linkTo} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getLinkTo(
org.opencrx.kernel.document1.cci2.DocumentLinkToQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code linkTo} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentLinkTo getLinkTo(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code linkTo} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getLinkTo(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentLinkTo getLinkTo(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code linkTo}.
*
* Note: This is an extension to the JMI 1 standard.
* @param idIsPersistent {@code true} if {@code id} is persistent
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param linkTo The element to be appended.
*/
public void addLinkTo (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentLinkTo linkTo
);
/**
* Adds the specified element to the set of the values for the reference {@code linkTo} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param linkTo The element to be appended.
*/
public void addLinkTo (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentLinkTo linkTo
);
/**
* Adds the specified element to the set of the values for the reference {@code linkTo} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param linkTo The element to be appended.
*/
public void addLinkTo (
org.opencrx.kernel.document1.jmi1.DocumentLinkTo linkTo
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code lock} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getLock(
org.opencrx.kernel.document1.cci2.DocumentLockQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code lock} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentLock getLock(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code lock} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getLock(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentLock getLock(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code lock}.
*
* Note: This is an extension to the JMI 1 standard.
* @param idIsPersistent {@code true} if {@code id} is persistent
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param lock The element to be appended.
*/
public void addLock (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentLock lock
);
/**
* Adds the specified element to the set of the values for the reference {@code lock} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param lock The element to be appended.
*/
public void addLock (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentLock lock
);
/**
* Adds the specified element to the set of the values for the reference {@code lock} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param lock The element to be appended.
*/
public void addLock (
org.opencrx.kernel.document1.jmi1.DocumentLock lock
);
// ----------------------------------------------------------------------------
// 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.jmi1.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/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code revision} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getRevision(
org.opencrx.kernel.document1.cci2.DocumentRevisionQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code revision} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentRevision getRevision(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code revision} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getRevision(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentRevision getRevision(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code revision}.
*
* Note: This is an extension to the JMI 1 standard.
* @param idIsPersistent {@code true} if {@code id} is persistent
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param revision The element to be appended.
*/
public void addRevision (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentRevision revision
);
/**
* Adds the specified element to the set of the values for the reference {@code revision} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param revision The element to be appended.
*/
public void addRevision (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentRevision revision
);
/**
* Adds the specified element to the set of the values for the reference {@code revision} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param revision The element to be appended.
*/
public void addRevision (
org.opencrx.kernel.document1.jmi1.DocumentRevision revision
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.document1.jmi1.ValidateSchemaResult validateSchema(
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
}