public interface CentraSiteQueryManager
extends javax.xml.registry.BusinessQueryManager
Modifier and Type | Field and Description |
---|---|
static java.util.Collection<java.lang.String> |
ANY_NAME_PATTERN
Convenience collection of pattern "%".
|
static java.util.Collection<java.lang.String> |
EXACT_NAME_NO_SORT_QUALIFIER
Convenience collection of FindQualifier.EXACT_NAME with no sorting.
|
static java.util.Collection<java.lang.String> |
EXACT_NAME_QUALIFIER
Convenience collection of FindQualifier.EXACT_NAME.
|
static java.util.Collection<java.lang.String> |
NO_SORT_QUALIFIER
Convenience collection of no sort qualifiers.
|
Modifier and Type | Method and Description |
---|---|
CentraSiteBusinessQuery |
createCentraSiteBusinessQuery(java.util.Collection objectTypes,
java.util.Collection findQualifiers)
CentraSiteBusinessQuery factory method.
|
CentraSiteBusinessQuery |
createCentraSiteBusinessQuery(java.lang.String objectType,
java.util.Collection findQualifiers)
CentraSiteBusinessQuery factory method.
|
javax.xml.registry.BulkResponse |
findClassifyingConcepts(java.util.Collection findQualifiers,
java.util.Collection objectTypes,
java.lang.String parentKey)
Gets the concepts that are immediate children of the given parent (which can be a taxonomy
or a concept), and that are used in at least one classification in the given set of object types.
|
javax.xml.registry.BulkResponse |
findObjects(java.util.Collection findQualifiers,
java.util.Collection namePatterns,
java.util.Collection classifications)
Deprecated.
for performance reasons
|
javax.xml.registry.BulkResponse |
findObjects(java.util.Collection findQualifiers,
java.util.Collection objectTypes,
java.util.Collection namePatterns,
java.util.Collection descriptionPatterns,
java.util.Collection classifications,
java.util.Collection externalIdentifiers,
java.util.Collection externalLinks)
Finds all registry objects that match the given criteria.
|
javax.xml.registry.BulkResponse |
findObjects(java.util.Collection findQualifiers,
java.util.Collection objectTypes,
java.lang.String queryPrologExtension,
java.lang.String queryPredicate)
Finds all registry objects of a given type that match a predicate
specified in XQuery syntax.
|
javax.xml.registry.BulkResponse |
findObjects(java.util.Collection findQualifiers,
java.lang.String objectType,
java.util.Collection namePatterns,
java.util.Collection descriptionPatterns,
java.util.Collection classifications,
java.util.Collection externalIdentifiers,
java.util.Collection externalLinks)
Finds all registry objects that match the given criteria.
|
javax.xml.registry.BulkResponse |
findObjects(java.util.Collection findQualifiers,
java.lang.String objectType,
java.lang.String queryPrologExtension,
java.lang.String queryPredicate)
Finds all registry objects of a given type that match a predicate
specified in XQuery syntax.
|
javax.xml.registry.BulkResponse |
findObjectsByAssociation(java.util.Collection<java.lang.String> findQualifiers,
java.lang.String objectType,
java.util.Collection<java.lang.String> targetObjectIds,
java.util.Collection<javax.xml.registry.infomodel.Concept> associationTypes)
Finds all objects of the given type that have associations whose
target object matches one of the given target ids and whose association type
is in the given collection of types.
|
javax.xml.registry.BulkResponse |
findObjectsByAssociation(java.util.Collection findQualifiers,
java.lang.String objectType,
java.lang.String targetObjectId,
java.util.Collection associationTypes)
Finds all objects of the given type that have associations whose
target object matches the given target id and whose association type
is in the given collection of types.
|
javax.xml.registry.BulkResponse |
findServicesByClassificationFilename(java.util.Collection<java.lang.String> findQualifiers,
javax.xml.registry.infomodel.ClassificationScheme taxonomy,
java.lang.String classificationValue,
java.lang.String uriSuffix)
Find services that have an external classification with the given taxonomy and classification value
and that have an ExternalLink that ends with the given uri suffix.
|
javax.xml.registry.BulkResponse |
findUserAssets(java.util.Collection findQualifiers,
javax.xml.registry.infomodel.User user)
Gets the top-level assets owned by the given user.
|
javax.xml.registry.BulkResponse |
findUsers(java.util.Collection findQualifiers,
java.util.Collection namePatterns)
Find users by name.
|
javax.xml.registry.BulkResponse |
findUsers(javax.xml.registry.infomodel.Key orgKey)
Find an organization's users by organization key.
|
java.util.Collection<CentraSiteBaseTypeDescription> |
getAllBaseTypeDescriptions()
Get all type base descriptions.
|
java.util.Collection<CentraSiteTypeDescription> |
getAllTypeDescriptions()
Gets all type descriptions.
|
java.util.Collection<CentraSiteVirtualTypeDescription> |
getAllVirtualTypeDescriptions()
Get all virtual type descriptions.
|
java.lang.String |
getQualifiedUserid(java.lang.String userName)
Transform the given user name to a qualified userid.
|
javax.xml.registry.BulkResponse |
getRegistryObjects(javax.xml.registry.infomodel.User user)
Gets the RegistryObjects owned by the given user.
|
java.util.Collection |
getSlotDescriptions(java.lang.String typeName)
For the given type , returns an ordered list of slot descriptions as defined in the schema.
|
java.util.Collection |
getSlotNames(java.lang.String typeName)
For the given type , returns an ordered list of slot names as defined in the schema.
|
CentraSiteTypeDescription |
getTypeDescription(java.lang.String typeName)
Returns the CentraSiteTypeDescription object for a given type.
|
java.lang.String |
getTypeName(java.lang.String xsdFileName)
Get the type name in the form "{uri}local-name" based on the given XSD file name.
|
InstanceLevelPrivilege |
getWebdavCurrentUserPrivilege(java.lang.String relativeUrl)
Get the Privilege of the current user for the given WebDAV resource.
|
InstanceLevelPermissionSet |
getWebdavPermissions(java.lang.String relativeUrl)
Return the instance level permissions for the given WebDAV resource.
|
static final java.util.Collection<java.lang.String> EXACT_NAME_QUALIFIER
static final java.util.Collection<java.lang.String> EXACT_NAME_NO_SORT_QUALIFIER
static final java.util.Collection<java.lang.String> NO_SORT_QUALIFIER
static final java.util.Collection<java.lang.String> ANY_NAME_PATTERN
javax.xml.registry.BulkResponse findObjects(java.util.Collection findQualifiers, java.util.Collection namePatterns, java.util.Collection classifications) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.namePatterns
- a Collection that may consist of either String or
LocalizedString objects. Each String or value within a
LocalizedString is a partial or full name pattern with
wildcard searching as specified by the SQL-92 LIKE
specification. Unless otherwise specified in findQualifiers,
this is a logical OR, and a match on any name qualifies as a
match for this criterion.classifications
- a Collection of Classification objects that classify the
object. It is analogous to a catgegoryBag in the UDDI
specification. Unless otherwise specified in findQualifiers,
this is a logical AND, and a match on all specified
Classifications qualifies as a match for this criterion. The
programmer may use the LifeCycleManager.createClassification
method to create a transient Classification for use in this
Collectionjavax.xml.registry.JAXRException
- if an internal error occurs on finding objectsjavax.xml.registry.BulkResponse findObjects(java.util.Collection findQualifiers, java.lang.String objectType, java.util.Collection namePatterns, java.util.Collection descriptionPatterns, java.util.Collection classifications, java.util.Collection externalIdentifiers, java.util.Collection externalLinks) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.objectType
- object type of the requested objects, usually specified as a
LifeCycleManager constant. A user defined object type can be
specified in the syntax given by
javax.xml.namespace.QName.toString(). For searching across all
object types, "*" can be specified. Must not be null.
Constants
.namePatterns
- a Collection that may consist of either String or
LocalizedString objects. Each String or value within a
LocalizedString is a partial or full name pattern with
wildcard searching as specified by the SQL-92 LIKE
specification. Unless otherwise specified in findQualifiers,
this is a logical OR, and a match on any name qualifies as a
match for this criterion.descriptionPatterns
- a Collection that may consist of either String or
LocalizedString objects. Each String or value within a
LocalizedString is a partial or full name pattern with
wildcard searching as specified by the SQL-92 LIKE
specification. Unless otherwise specified in findQualifiers,
this is a logical OR, and a match on any name qualifies as a
match for this criterion.classifications
- a Collection of Classification objects that classify the
object. It is analogous to a catgegoryBag in the UDDI
specification. Unless otherwise specified in findQualifiers,
this is a logical AND, and a match on all specified
Classifications qualifies as a match for this criterion. The
programmer may use the LifeCycleManager.createClassification
method to create a transient Classification for use in this
CollectionexternalIdentifiers
- a Collection of ExternalIdentifier objects that provide an
external identifier for the object using an identification
scheme such as DUNS. It is analogous to an identifierBag in
the UDDI specification. Unless otherwise specified in
findQualifiers, this is a logical AND, and a match on all
specified ExternalIdentifiers qualifies as a match for this
criterion. The programmer may use the
LifeCycleManager.createExternalIdentifier method to create a
transient ExternalIdentifier for use in this Collection.externalLinks
- a Collection of ExternalLink objects that link the object to
content outside the registry. It is analogous to an
overviewDoc in the UDDI specification. Unless otherwise
specified in findQualifiers, this is a logical AND, and a
match on all specified ExternalLinks qualifies as a match for
this criterion.javax.xml.registry.JAXRException
- if an internal error occurs on finding objectsjavax.xml.registry.BulkResponse findObjects(java.util.Collection findQualifiers, java.util.Collection objectTypes, java.util.Collection namePatterns, java.util.Collection descriptionPatterns, java.util.Collection classifications, java.util.Collection externalIdentifiers, java.util.Collection externalLinks) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.objectTypes
- a Collection of strings that restrict the object types of the
requested objects, usually specified as LifeCycleManager constants.
User defined object types can be specified in the syntax given by
javax.xml.namespace.QName.toString(). For searching across all
object types, "*" can be specified. If null, or an empty collection,
the result will be empty.
Constants
.namePatterns
- a Collection that may consist of either String or
LocalizedString objects. Each String or value within a
LocalizedString is a partial or full name pattern with
wildcard searching as specified by the SQL-92 LIKE
specification. Unless otherwise specified in findQualifiers,
this is a logical OR, and a match on any name qualifies as a
match for this criterion.descriptionPatterns
- a Collection that may consist of either String or
LocalizedString objects. Each String or value within a
LocalizedString is a partial or full name pattern with
wildcard searching as specified by the SQL-92 LIKE
specification. Unless otherwise specified in findQualifiers,
this is a logical OR, and a match on any name qualifies as a
match for this criterion.classifications
- a Collection of Classification objects that classify the
object. It is analogous to a catgegoryBag in the UDDI
specification. Unless otherwise specified in findQualifiers,
this is a logical AND, and a match on all specified
Classifications qualifies as a match for this criterion. The
programmer may use the LifeCycleManager.createClassification
method to create a transient Classification for use in this
CollectionexternalIdentifiers
- a Collection of ExternalIdentifier objects that provide an
external identifier for the object using an identification
scheme such as DUNS. It is analogous to an identifierBag in
the UDDI specification. Unless otherwise specified in
findQualifiers, this is a logical AND, and a match on all
specified ExternalIdentifiers qualifies as a match for this
criterion. The programmer may use the
LifeCycleManager.createExternalIdentifier method to create a
transient ExternalIdentifier for use in this Collection.externalLinks
- a Collection of ExternalLink objects that link the object to
content outside the registry. It is analogous to an
overviewDoc in the UDDI specification. Unless otherwise
specified in findQualifiers, this is a logical AND, and a
match on all specified ExternalLinks qualifies as a match for
this criterion.javax.xml.registry.JAXRException
- if an internal error occurs on finding objectsjavax.xml.registry.BulkResponse findObjects(java.util.Collection findQualifiers, java.lang.String objectType, java.lang.String queryPrologExtension, java.lang.String queryPredicate) throws javax.xml.registry.JAXRException
declare namespace cs="http://namespaces.CentraSite.com/Schema/jaxr"; declare namespace dt={-- object type namespace --}; {-- queryPrologExtension goes here --} for $ro in collection("CentraSite")/{-- object type --} where {-- queryPredicate goes here --} return $ro/cs:key
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.objectType
- object type of the requested objects, usually specified as a
LifeCycleManager constant. A user defined object type can be
specified in the syntax given by
javax.xml.namespace.QName.toString(). For searching across all
object types, "*" can be specified. Must not be null.
Constants
.queryPrologExtension
- a String containing any extra XQuery prolog entries. This
entry can contain arbitrary prolog entries, e.g. namespace
declarations, query functions etc., as needed by the
queryPredicate. Can be null if no extra prolog entries are
required.queryPredicate
- the predicate qualifying the object in XQuery syntax. The
context for this predicate will be a WHERE clause in an XQuery
FLWR expression enumerating registry objects corresponding to
the objectType parameter. Variable $ro contains a registry
object in question. Namespace prefix cs is defined for the
CentraSite JAXR namespace; namespece prefix dt may be defined
for the namespace of a user defined object type. This
parameter Can be null if asking for all registry objects of a
given type.javax.xml.registry.JAXRException
- if an internal error occurs on finding objectsjavax.xml.registry.BulkResponse findObjects(java.util.Collection findQualifiers, java.util.Collection objectTypes, java.lang.String queryPrologExtension, java.lang.String queryPredicate) throws javax.xml.registry.JAXRException
declare namespace cs="http://namespaces.CentraSite.com/Schema/jaxr"; declare namespace dt={-- object type namespace --}; {-- queryPrologExtension goes here --} for $ro in collection("CentraSite")/{-- object type --} where {-- queryPredicate goes here --} return $ro/cs:key
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.objectTypes
- a Collection of strings that restrict the object types of the
requested objects, usually specified as LifeCycleManager constants.
User defined object types can be specified in the syntax given by
javax.xml.namespace.QName.toString(). For searching across all
object types, "*" can be specified. If null, or an empty collection,
the result will be empty.
Constants
.queryPrologExtension
- a String containing any extra XQuery prolog entries. This
entry can contain arbitrary prolog entries, e.g. namespace
declarations, query functions etc., as needed by the
queryPredicate. Can be null if no extra prolog entries are
required.queryPredicate
- the predicate qualifying the object in XQuery syntax. The
context for this predicate will be a WHERE clause in an XQuery
FLWR expression enumerating registry objects corresponding to
the objectType parameter. Variable $ro contains a registry
object in question. Namespace prefix cs is defined for the
CentraSite JAXR namespace; namespece prefix dt may be defined
for the namespace of a user defined object type. This
parameter Can be null if asking for all registry objects of a
given type.javax.xml.registry.JAXRException
- if an internal error occurs on finding objectsjavax.xml.registry.BulkResponse findObjectsByAssociation(java.util.Collection findQualifiers, java.lang.String objectType, java.lang.String targetObjectId, java.util.Collection associationTypes) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.objectType
- object type of the requested objects, usually specified as a
LifeCycleManager constant. A user defined object type can be
specified in the syntax given by
javax.xml.namespace.QName.toString(). For searching across all
object types, "*" can be specified. Must not be null.
Constants
.targetObjectId
- a String that represents the id for a RegistryObject that must
be the targetObject of the Associations that match. This parameter
is ignored if specified as null.associationTypes
- a Collection of associationTypes. This is a logical OR operation
across the collection. This parameter is ignored if specified as null.BulkResponse
javax.xml.registry.JAXRException
- if an internal error occursjavax.xml.registry.BulkResponse findObjectsByAssociation(java.util.Collection<java.lang.String> findQualifiers, java.lang.String objectType, java.util.Collection<java.lang.String> targetObjectIds, java.util.Collection<javax.xml.registry.infomodel.Concept> associationTypes) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.objectType
- object type of the requested objects, usually specified as a
LifeCycleManager constant. A user defined object type can be
specified in the syntax given by
javax.xml.namespace.QName.toString(). For searching across all
object types, "*" can be specified. Must not be null.
Constants
.targetObjectIds
- a collection of String that represents the ids of RegistryObjects that must
be the targetObject of the Associations that match. This parameter
is ignored if specified as null.associationTypes
- a Collection of associationTypes. This is a logical OR operation
across the collection. This parameter is ignored if specified as null.BulkResponse
javax.xml.registry.JAXRException
- if an internal error occursjavax.xml.registry.BulkResponse findUsers(javax.xml.registry.infomodel.Key orgKey) throws javax.xml.registry.JAXRException
orgKey
- the organizations keyjavax.xml.registry.JAXRException
- if an internal error occurs on finding usersjavax.xml.registry.BulkResponse findUsers(java.util.Collection findQualifiers, java.util.Collection namePatterns) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the FindQualifier interface,
which specifies qualifiers that affect string matching, sorting, boolean predicate logic, and the like.namePatterns
- the collection of name pattern to match.javax.xml.registry.JAXRException
- if an internal error occurs on finding usersjava.util.Collection getSlotNames(java.lang.String typeName) throws javax.xml.registry.JAXRException
typeName
- the type name as {uri}local-namejavax.xml.registry.JAXRException
java.util.Collection getSlotDescriptions(java.lang.String typeName) throws javax.xml.registry.JAXRException
typeName
- the type name as {uri}local-namejavax.xml.registry.JAXRException
- if an internal error occurs on retrieving slot descriptionsCentraSiteSlotDescription
CentraSiteTypeDescription getTypeDescription(java.lang.String typeName) throws javax.xml.registry.JAXRException
typeName
- the type name as {uri}local-namejavax.xml.registry.JAXRException
- if an internal error occurs on retrieving type descriptionjava.util.Collection<CentraSiteTypeDescription> getAllTypeDescriptions() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving all type descriptionsjava.util.Collection<CentraSiteBaseTypeDescription> getAllBaseTypeDescriptions() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving all type descriptionsjava.util.Collection<CentraSiteVirtualTypeDescription> getAllVirtualTypeDescriptions() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving all virtual type descriptionsjava.lang.String getTypeName(java.lang.String xsdFileName) throws javax.xml.registry.JAXRException
xsdFileName
- the XSD file name, starting with "/projects", e.g.:
/projects/CentraSite/XMLSchemas/_7Bnamespace_7Dtypename.xsdjavax.xml.registry.JAXRException
- @throws JAXRException if an internal error occurs on retrieving type nameInstanceLevelPermissionSet getWebdavPermissions(java.lang.String relativeUrl) throws javax.xml.registry.JAXRException
relativeUrl
- the relative URL of the WebDAV resourcejavax.xml.registry.JAXRException
- @throws JAXRException if an internal error occurs on retrieving webdav permissionsInstanceLevelPrivilege getWebdavCurrentUserPrivilege(java.lang.String relativeUrl) throws javax.xml.registry.JAXRException
relativeUrl
- the relative URL of the WebDAV resourcejavax.xml.registry.JAXRException
- @throws JAXRException if an internal error occurs on retrieving webdav current user privilegeCentraSiteBusinessQuery createCentraSiteBusinessQuery(java.util.Collection objectTypes, java.util.Collection findQualifiers) throws javax.xml.registry.JAXRException
objectTypes
- the path of the doctype or element representing the target object in the databasefindQualifiers
- a Collection of find qualifiers as defined by the FindQualifier interface,
which specifies qualifiers that affect string matching, sorting, boolean predicate logic, and the like.CentraSiteBusinessQuery
objectjavax.xml.registry.JAXRException
- if an internal error occursCentraSiteBusinessQuery createCentraSiteBusinessQuery(java.lang.String objectType, java.util.Collection findQualifiers) throws javax.xml.registry.JAXRException
objectType
- the path of the doctype or element representing the target object in the databasefindQualifiers
- a Collection of find qualifiers as defined by the FindQualifier interface,
which specifies qualifiers that affect string matching, sorting, boolean predicate logic, and the like.CentraSiteBusinessQuery
objectjavax.xml.registry.JAXRException
- if an internal error occursjavax.xml.registry.BulkResponse getRegistryObjects(javax.xml.registry.infomodel.User user) throws javax.xml.registry.JAXRException
user
- the user owning the requested objectsjavax.xml.registry.JAXRException
- if an internal error occursjavax.xml.registry.BulkResponse findUserAssets(java.util.Collection findQualifiers, javax.xml.registry.infomodel.User user) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the FindQualifier interface,
which specifies qualifiers that affect string matching, sorting, boolean predicate logic, and the like.user
- the user owning the requested objectsjavax.xml.registry.JAXRException
- if an internal error occursjavax.xml.registry.BulkResponse findClassifyingConcepts(java.util.Collection findQualifiers, java.util.Collection objectTypes, java.lang.String parentKey) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.objectTypes
- a Collection of strings that restrict the object types of the
requested objects, usually specified as LifeCycleManager constants.
User defined object types can be specified in the syntax given by
javax.xml.namespace.QName.toString(). If null, or an empty collection,
the result will be empty.
Constants
.parentKey
- the key of the concepts' parent object (taxonomy or concept)javax.xml.registry.JAXRException
- if an internal error occursjavax.xml.registry.BulkResponse findServicesByClassificationFilename(java.util.Collection<java.lang.String> findQualifiers, javax.xml.registry.infomodel.ClassificationScheme taxonomy, java.lang.String classificationValue, java.lang.String uriSuffix) throws javax.xml.registry.JAXRException
findQualifiers
- a Collection of find qualifiers as defined by the
FindQualifier interface, which specifies qualifiers that
affect string matching, sorting, boolean predicate logic, and
the like.taxonomy
- the classifying taxonomyclassificationValue
- the classification valueuriSuffix
- the uri suffixjavax.xml.registry.JAXRException
- if an internal error occursjava.lang.String getQualifiedUserid(java.lang.String userName) throws javax.xml.registry.JAXRException
userName
- the user name as String objectjavax.xml.registry.JAXRException
- if an internal error occurs