org.opencrx.kernel.document1.cci2
Interface DocumentQuery

All Superinterfaces:
AnyTypePredicate, AuditeeQuery, org.openmdx.base.cci2.BasicObjectQuery, org.openmdx.base.cci2.ContextCapableQuery, org.openmdx.base.cci2.ExtentCapableQuery, ImporterQuery, IndexedQuery, SecureObjectQuery, org.openmdx.compatibility.view1.cci2.ViewCapableQuery, XmlExporterQuery

public interface DocumentQuery
extends AuditeeQuery, ImporterQuery, IndexedQuery, SecureObjectQuery, XmlExporterQuery, org.openmdx.base.cci2.BasicObjectQuery


Method Summary
 OptionalFeaturePredicate activeOn()
          Adds a constraint to the predicate for Document testing whether the value of the feature activeOn is null or not.
 OptionalFeaturePredicate activeUntil()
          Adds a constraint to the predicate for Document testing whether the value of the feature activeUntil is null or not.
 OptionalFeaturePredicate author()
          Adds a constraint to the predicate for Document testing whether the value of the feature author is null or not.
 ComparableTypePredicate<Short> contentLanguage()
           
 OptionalFeaturePredicate contentLength()
          Adds a constraint to the predicate for Document testing whether the value of the feature contentLength is null or not.
 OptionalFeaturePredicate contentType()
          Adds a constraint to the predicate for Document testing whether the value of the feature contentType is null or not.
 OptionalFeaturePredicate documentAbstract()
          Adds a constraint to the predicate for Document testing whether the value of the feature documentAbstract is null or not.
 OptionalFeaturePredicate documentNumber()
          Adds a constraint to the predicate for Document testing whether the value of the feature documentNumber is null or not.
 ComparableTypePredicate<Short> documentState()
           
 ComparableTypePredicate<Short> documentType()
           
 MultivaluedFeaturePredicate folder()
          Adds a constraint to the predicate for Document testing whether the feature folder has values or not.
 ComparableTypePredicate<Date> forAllActiveOn()
          Adds a constraint for the feature activeOn to the predicate.
 ComparableTypePredicate<Date> forAllActiveUntil()
          Adds a constraint for the feature activeUntil to the predicate.
 StringTypePredicate forAllAuthor()
          Adds a constraint for the feature author to the predicate.
 ComparableTypePredicate<Integer> forAllContentLength()
          Adds a constraint for the feature contentLength to the predicate.
 StringTypePredicate forAllContentType()
          Adds a constraint for the feature contentType to the predicate.
 StringTypePredicate forAllDocumentAbstract()
          Adds a constraint for the feature documentAbstract to the predicate.
 StringTypePredicate forAllDocumentNumber()
          Adds a constraint for the feature documentNumber to the predicate.
 DocumentFolderQuery forAllFolder()
          Adds a constraint for the feature folder to the predicate.
 DocumentRevisionQuery forAllHeadRevision()
          Adds a constraint for the feature headRevision to the predicate.
 StringTypePredicate forAllKeywords()
          Adds a constraint for the feature keywords to the predicate.
 StringTypePredicate forAllLocation()
          Adds a constraint for the feature location to the predicate.
 StringTypePredicate forAllSearchText()
          Adds a constraint for the feature searchText to the predicate.
 StringTypePredicate forAllTitle()
          Adds a constraint for the feature title to the predicate.
 OptionalFeaturePredicate headRevision()
          Adds a constraint to the predicate for Document testing whether the value of the feature headRevision is null or not.
 OptionalFeaturePredicate keywords()
          Adds a constraint to the predicate for Document testing whether the value of the feature keywords is null or not.
 ComparableTypePredicate<Short> literatureType()
           
 OptionalFeaturePredicate location()
          Adds a constraint to the predicate for Document testing whether the value of the feature location is null or not.
 SimpleTypeOrder orderByActiveOn()
          Allows to adds a sort instruction for Document depending the feature activeOn Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByActiveUntil()
          Allows to adds a sort instruction for Document depending the feature activeUntil Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByAuthor()
          Allows to adds a sort instruction for Document depending the feature author Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByContentLanguage()
          Allows to adds a sort instruction for Document depending the feature contentLanguage Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByContentLength()
          Allows to adds a sort instruction for Document depending the feature contentLength Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByContentType()
          Allows to adds a sort instruction for Document depending the feature contentType Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByDocumentAbstract()
          Allows to adds a sort instruction for Document depending the feature documentAbstract Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByDocumentNumber()
          Allows to adds a sort instruction for Document depending the feature documentNumber Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByDocumentState()
          Allows to adds a sort instruction for Document depending the feature documentState Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByDocumentType()
          Allows to adds a sort instruction for Document depending the feature documentType Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByKeywords()
          Allows to adds a sort instruction for Document depending the feature keywords Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByLiteratureType()
          Allows to adds a sort instruction for Document depending the feature literatureType Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByLocation()
          Allows to adds a sort instruction for Document depending the feature location Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderBySearchText()
          Allows to adds a sort instruction for Document depending the feature searchText Note: The order in which orderBy… instructions are given is relevant!
 SimpleTypeOrder orderByTitle()
          Allows to adds a sort instruction for Document depending the feature title Note: The order in which orderBy… instructions are given is relevant!
 OptionalFeaturePredicate searchText()
          Adds a constraint to the predicate for Document testing whether the value of the feature searchText is null or not.
 ComparableTypePredicate<Date> thereExistsActiveOn()
          Adds a constraint for the feature activeOn to the predicate.
 ComparableTypePredicate<Date> thereExistsActiveUntil()
          Adds a constraint for the feature activeUntil to the predicate.
 StringTypePredicate thereExistsAuthor()
          Adds a constraint for the feature author to the predicate.
 ComparableTypePredicate<Integer> thereExistsContentLength()
          Adds a constraint for the feature contentLength to the predicate.
 StringTypePredicate thereExistsContentType()
          Adds a constraint for the feature contentType to the predicate.
 StringTypePredicate thereExistsDocumentAbstract()
          Adds a constraint for the feature documentAbstract to the predicate.
 StringTypePredicate thereExistsDocumentNumber()
          Adds a constraint for the feature documentNumber to the predicate.
 DocumentFolderQuery thereExistsFolder()
          Adds a constraint for the feature folder to the predicate.
 DocumentRevisionQuery thereExistsHeadRevision()
          Adds a constraint for the feature headRevision to the predicate.
 StringTypePredicate thereExistsKeywords()
          Adds a constraint for the feature keywords to the predicate.
 StringTypePredicate thereExistsLocation()
          Adds a constraint for the feature location to the predicate.
 StringTypePredicate thereExistsSearchText()
          Adds a constraint for the feature searchText to the predicate.
 StringTypePredicate thereExistsTitle()
          Adds a constraint for the feature title to the predicate.
 OptionalFeaturePredicate title()
          Adds a constraint to the predicate for Document testing whether the value of the feature title is null or not.
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObjectQuery
accessGrantedByParent, accessLevelBrowse, accessLevelDelete, accessLevelUpdate, forAllAccessGrantedByParent, forAllOwner, forAllOwningGroup, forAllOwningUser, orderByAccessLevelBrowse, orderByAccessLevelDelete, orderByAccessLevelUpdate, orderByOwner, owner, owningGroup, owningUser, thereExistsAccessGrantedByParent, thereExistsOwner, thereExistsOwningGroup, thereExistsOwningUser
 
Methods inherited from interface org.openmdx.base.cci2.BasicObjectQuery
createdAt, createdBy, forAllCreatedBy, forAllModifiedBy, modifiedAt, modifiedBy, orderByCreatedAt, orderByCreatedBy, orderByModifiedAt, orderByModifiedBy, thereExistsCreatedBy, thereExistsModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.ContextCapableQuery
context, forAllContext, thereExistsContext
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapableQuery
identity, orderByIdentity
 
Methods inherited from interface org.w3c.cci2.AnyTypePredicate
elementOf, elementOf, equalTo, notAnElementOf, notAnElementOf, notEqualTo
 

Method Detail

activeOn

OptionalFeaturePredicate activeOn()
Adds a constraint to the predicate for Document testing whether the value of the feature activeOn is null or not.


thereExistsActiveOn

ComparableTypePredicate<Date> thereExistsActiveOn()
Adds a constraint for the feature activeOn to the predicate. The predicate for Document evaluates true if its value of feature activeOn satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllActiveOn

ComparableTypePredicate<Date> forAllActiveOn()
Adds a constraint for the feature activeOn to the predicate. The predicate for Document evaluates true if its value of feature activeOn satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByActiveOn

SimpleTypeOrder orderByActiveOn()
Allows to adds a sort instruction for Document depending the feature activeOn Note: The order in which orderBy… instructions are given is relevant!


activeUntil

OptionalFeaturePredicate activeUntil()
Adds a constraint to the predicate for Document testing whether the value of the feature activeUntil is null or not.


thereExistsActiveUntil

ComparableTypePredicate<Date> thereExistsActiveUntil()
Adds a constraint for the feature activeUntil to the predicate. The predicate for Document evaluates true if its value of feature activeUntil satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllActiveUntil

ComparableTypePredicate<Date> forAllActiveUntil()
Adds a constraint for the feature activeUntil to the predicate. The predicate for Document evaluates true if its value of feature activeUntil satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByActiveUntil

SimpleTypeOrder orderByActiveUntil()
Allows to adds a sort instruction for Document depending the feature activeUntil Note: The order in which orderBy… instructions are given is relevant!


author

OptionalFeaturePredicate author()
Adds a constraint to the predicate for Document testing whether the value of the feature author is null or not.


thereExistsAuthor

StringTypePredicate thereExistsAuthor()
Adds a constraint for the feature author to the predicate. The predicate for Document evaluates true if its value of feature author satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllAuthor

StringTypePredicate forAllAuthor()
Adds a constraint for the feature author to the predicate. The predicate for Document evaluates true if its value of feature author satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByAuthor

SimpleTypeOrder orderByAuthor()
Allows to adds a sort instruction for Document depending the feature author Note: The order in which orderBy… instructions are given is relevant!


contentLanguage

ComparableTypePredicate<Short> contentLanguage()

orderByContentLanguage

SimpleTypeOrder orderByContentLanguage()
Allows to adds a sort instruction for Document depending the feature contentLanguage Note: The order in which orderBy… instructions are given is relevant!


contentLength

OptionalFeaturePredicate contentLength()
Adds a constraint to the predicate for Document testing whether the value of the feature contentLength is null or not.


thereExistsContentLength

ComparableTypePredicate<Integer> thereExistsContentLength()
Adds a constraint for the feature contentLength to the predicate. The predicate for Document evaluates true if its value of feature contentLength satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllContentLength

ComparableTypePredicate<Integer> forAllContentLength()
Adds a constraint for the feature contentLength to the predicate. The predicate for Document evaluates true if its value of feature contentLength satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByContentLength

SimpleTypeOrder orderByContentLength()
Allows to adds a sort instruction for Document depending the feature contentLength Note: The order in which orderBy… instructions are given is relevant!


contentType

OptionalFeaturePredicate contentType()
Adds a constraint to the predicate for Document testing whether the value of the feature contentType is null or not.


thereExistsContentType

StringTypePredicate thereExistsContentType()
Adds a constraint for the feature contentType to the predicate. The predicate for Document evaluates true if its value of feature contentType satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllContentType

StringTypePredicate forAllContentType()
Adds a constraint for the feature contentType to the predicate. The predicate for Document evaluates true if its value of feature contentType satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByContentType

SimpleTypeOrder orderByContentType()
Allows to adds a sort instruction for Document depending the feature contentType Note: The order in which orderBy… instructions are given is relevant!


documentAbstract

OptionalFeaturePredicate documentAbstract()
Adds a constraint to the predicate for Document testing whether the value of the feature documentAbstract is null or not.


thereExistsDocumentAbstract

StringTypePredicate thereExistsDocumentAbstract()
Adds a constraint for the feature documentAbstract to the predicate. The predicate for Document evaluates true if its value of feature documentAbstract satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllDocumentAbstract

StringTypePredicate forAllDocumentAbstract()
Adds a constraint for the feature documentAbstract to the predicate. The predicate for Document evaluates true if its value of feature documentAbstract satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByDocumentAbstract

SimpleTypeOrder orderByDocumentAbstract()
Allows to adds a sort instruction for Document depending the feature documentAbstract Note: The order in which orderBy… instructions are given is relevant!


documentNumber

OptionalFeaturePredicate documentNumber()
Adds a constraint to the predicate for Document testing whether the value of the feature documentNumber is null or not.


thereExistsDocumentNumber

StringTypePredicate thereExistsDocumentNumber()
Adds a constraint for the feature documentNumber to the predicate. The predicate for Document evaluates true if its value of feature documentNumber satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllDocumentNumber

StringTypePredicate forAllDocumentNumber()
Adds a constraint for the feature documentNumber to the predicate. The predicate for Document evaluates true if its value of feature documentNumber satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByDocumentNumber

SimpleTypeOrder orderByDocumentNumber()
Allows to adds a sort instruction for Document depending the feature documentNumber Note: The order in which orderBy… instructions are given is relevant!


documentState

ComparableTypePredicate<Short> documentState()

orderByDocumentState

SimpleTypeOrder orderByDocumentState()
Allows to adds a sort instruction for Document depending the feature documentState Note: The order in which orderBy… instructions are given is relevant!


documentType

ComparableTypePredicate<Short> documentType()

orderByDocumentType

SimpleTypeOrder orderByDocumentType()
Allows to adds a sort instruction for Document depending the feature documentType Note: The order in which orderBy… instructions are given is relevant!


folder

MultivaluedFeaturePredicate folder()
Adds a constraint to the predicate for Document testing whether the feature folder has values or not.


thereExistsFolder

DocumentFolderQuery thereExistsFolder()
Adds a constraint for the feature folder to the predicate. The predicate for Document evaluates true if its value of feature folder satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllFolder

DocumentFolderQuery forAllFolder()
Adds a constraint for the feature folder to the predicate. The predicate for Document evaluates true if its value of feature folder satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


headRevision

OptionalFeaturePredicate headRevision()
Adds a constraint to the predicate for Document testing whether the value of the feature headRevision is null or not.


thereExistsHeadRevision

DocumentRevisionQuery thereExistsHeadRevision()
Adds a constraint for the feature headRevision to the predicate. The predicate for Document evaluates true if its value of feature headRevision satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllHeadRevision

DocumentRevisionQuery forAllHeadRevision()
Adds a constraint for the feature headRevision to the predicate. The predicate for Document evaluates true if its value of feature headRevision satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


keywords

OptionalFeaturePredicate keywords()
Adds a constraint to the predicate for Document testing whether the value of the feature keywords is null or not.


thereExistsKeywords

StringTypePredicate thereExistsKeywords()
Adds a constraint for the feature keywords to the predicate. The predicate for Document evaluates true if its value of feature keywords satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllKeywords

StringTypePredicate forAllKeywords()
Adds a constraint for the feature keywords to the predicate. The predicate for Document evaluates true if its value of feature keywords satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByKeywords

SimpleTypeOrder orderByKeywords()
Allows to adds a sort instruction for Document depending the feature keywords Note: The order in which orderBy… instructions are given is relevant!


literatureType

ComparableTypePredicate<Short> literatureType()

orderByLiteratureType

SimpleTypeOrder orderByLiteratureType()
Allows to adds a sort instruction for Document depending the feature literatureType Note: The order in which orderBy… instructions are given is relevant!


location

OptionalFeaturePredicate location()
Adds a constraint to the predicate for Document testing whether the value of the feature location is null or not.


thereExistsLocation

StringTypePredicate thereExistsLocation()
Adds a constraint for the feature location to the predicate. The predicate for Document evaluates true if its value of feature location satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllLocation

StringTypePredicate forAllLocation()
Adds a constraint for the feature location to the predicate. The predicate for Document evaluates true if its value of feature location satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByLocation

SimpleTypeOrder orderByLocation()
Allows to adds a sort instruction for Document depending the feature location Note: The order in which orderBy… instructions are given is relevant!


searchText

OptionalFeaturePredicate searchText()
Adds a constraint to the predicate for Document testing whether the value of the feature searchText is null or not.


thereExistsSearchText

StringTypePredicate thereExistsSearchText()
Adds a constraint for the feature searchText to the predicate. The predicate for Document evaluates true if its value of feature searchText satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllSearchText

StringTypePredicate forAllSearchText()
Adds a constraint for the feature searchText to the predicate. The predicate for Document evaluates true if its value of feature searchText satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderBySearchText

SimpleTypeOrder orderBySearchText()
Allows to adds a sort instruction for Document depending the feature searchText Note: The order in which orderBy… instructions are given is relevant!


title

OptionalFeaturePredicate title()
Adds a constraint to the predicate for Document testing whether the value of the feature title is null or not.


thereExistsTitle

StringTypePredicate thereExistsTitle()
Adds a constraint for the feature title to the predicate. The predicate for Document evaluates true if its value of feature title satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to false!


forAllTitle

StringTypePredicate forAllTitle()
Adds a constraint for the feature title to the predicate. The predicate for Document evaluates true if its value of feature title satisfies the selected condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the predicate evaluates to true!


orderByTitle

SimpleTypeOrder orderByTitle()
Allows to adds a sort instruction for Document depending the feature title Note: The order in which orderBy… instructions are given is relevant!



This software is published under the BSD license. Copyright © 2003-2007, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.