Documentation on the RepositoryFramework Web Service

This is the documentation on the RepositoryFramework Web Service. The Respository Framework is a framework managing and providing access means to repositories. A repository is either a store holding resources or an adapter making resources from other stores available. Resources is a term used for data in general, e.g. documents in a document store. This was the origin of the Repository Framework - being a content management system for documents. The framework allows different stores to be handled uniquely by a general client API - this Web Service exposes this API. Repositories on the other hand are plugged-in through the general manager API - this knowledge is only important to store implementors and is not covered by this Web Service.

The functionality is split into aspects - each focusing on certain areas of functionality. See below for information on these aspects. Each aspect consists of different methods which are all visible at the Web Service, complex types which are used in the signatures of the methods and exceptions thrown by these methods. Methods have input and output parameters. Complex types have fields and methods, which again have input and output parameters. Exceptions carry data. The methods offer a procedural API, the complex types are used as value objects/data transport objects whenever primtive data types were not sufficient and the exceptions encapsulate more valuable information than plain SOAP faults.

Aspects
Lookup Lookup operations.
Namespace Namespace operations.
Property Property operations.
Content Content operations.
Lock Lock operations.
Security Security operations.
Version Version operations.
PerfRF Performance operations.
CfgRF Config operations.

Lookup Aspect

This aspect covers lookup operations. Lookup operations are operations used to look up resources identified by resource identifiers in an repository. The resource identifier of a resource is the address of the resource and identifies exactly this single resource.

Methods and Parameters for Aspect Lookup
Resource lookup(String rid, FetchGroup fetchGroup)
Look up a resource and pre-fetch its data.
Resource[] lookupMass(String[] rids, FetchGroup fetchGroup)
Look up resources and pre-fetch their data.

Complex types for Aspect Lookup
FetchGroup Fetch group
ResourceUrl Resource url
Resource Resource
Collection Collection
Document Document
Link Link

Method and Parameters Details for Aspect Lookup

lookup

public Resource lookup(String rid, FetchGroup fetchGroup)

Look up a resource by its resource identifier and pre-fetch its data by a fetch group.

Parameters:
Returns:
Throws:

lookupMass

public Resource[] lookupMass(String[] rids, FetchGroup fetchGroup)

Look up resources by their resource identifiers (mass call) and pre-fetch their data by a fetch group. A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

Complex Type Details for Aspect Lookup

FetchGroup

A fetch group provides a mechanism to specify which parts of a resource should be pre-fetched, i.e. returned with the resource.

Fields and Constants
boolean generateGuid Field: Generate guid for resource (performance critical)
int includeProperties Field: Include certain properties (Optional)
" PROPERTIES_DEFAULT Constant with value 0: Default properties
" PROPERTIES_NONE Constant with value 1: No properties
" PROPERTIES_SYSTEM Constant with value 2: System properties
" PROPERTIES_SELECTED Constant with value 3: Selected properties (specified by selectPropertyNames)
" PROPERTIES_ALL Constant with value 100: All properties
String[] selectPropertyNames Field: List of property names evaluated with SELECTED_PROPERTIES (Optional)
int includeUrls Field: Include certain urls (Optional)
" URLS_DEFAULT Constant with value 0: Default urls
" URLS_NONE Constant with value 1: No urls
" URLS_SELECTED Constant with value 3: Selected urls (specified by selectUrlTypes)
" URLS_ALL Constant with value 100: All urls
int[] selectUrlTypes Field: List of url types evaluated with URLS_SELECTED (Optional)
boolean includeContentMetadata Field: Include content metadata

ResourceUrl

A resource url holds a type identifying the url and the url itself.

Fields and Constants
int type Field: Type
" TYPE_CONTENT Constant with value 1: Content url
" TYPE_CONTENT_WITH_GUID Constant with value 2: Content url (with short GUID url/performance critical)
" TYPE_DETAILS Constant with value 3: Details url
String url Field: Url

Resource

A resource is the central data unit in the Repository framework. It exists in different flavors: Collections (having further resources assigned to it in a parent/child relationship), documents (being only leaves in the hierarchy tree of resources and possibly having content) and links (referencing other resources or objects). Everything revoles around the resource: It holds propreties further defining it and most operations are based on them or at their identifiers, called resource identifiers or RIDs. A RID is a hierarchy based unique address (string) to the resource, just like URLs are to Web documents. Only returned resources with the valid flag set to true are fully constructed resources. If this flag is not set, the resource couldn't be fully constructed and only the RID may be extracted and used - everything else is not available.

Fields and Constants
String rid Field: Resource identifier
String accessRid Field: RID used for retrieval (RIDs differ when coming from a link)
String parentRid Field: Parent rid (all segments of RID before resource name)
String resourceName Field: Resource name (last segment of RID)
String displayName Field: Display name
String guid Field: Globally unique identifier
Boolean collection Field: Collection (indicating a resource collection)
Boolean link Field: Link (indicating a resource link)
Boolean versioned Field: Versioned (indicating a versioned resource)
boolean valid Field: Valid (indicating a valid resource) A resource is invalid if not all fields of the resource could be filled correctly (e.g. not all properties could be retrieved for permission reasons)
Property[] properties Field: Properties of this resource
ContentMetadata contentMetadata Field: Content metadata of this resource
ResourceUrl[] urls Field: Urls of this resource
FetchGroup fetchGroup Field: Fetch group of this resource

Collection

A collection is a specialization of a resource, having further resources assigned to it in a parent/child relationship.

Fields and Constants

Document

A document is a specialization of a resource, being only a leaf in the hierarchy tree of resources and possibly having content.

Fields and Constants

Link

A link is a specialization of a resource, referencing other resources or objects.

Fields and Constants

Namespace Aspect

This aspect covers namespace operations. Namespace operations are operations reading or manipulating the hierarchy of resources in the repository. Retrieving all child resources of a collection is an example of reading - creating a new document is an example of writing.

Methods and Parameters for Aspect Namespace
Resource[] findResources(String rootRid, FindDescriptor findDescriptor, boolean includeInvalidResources, FetchGroup fetchGroup)
Find resources below a root resource (incl. queries/sort).
ResourcesChunk findResourcesFirstChunk(String rootRid, FindDescriptor findDescriptor, boolean includeInvalidResources, FetchGroup fetchGroup, long timeout, int count)
Page resources below a root resource (incl. queries/sort).
ResourcesChunk findResourcesNextChunk(String token, int count)
Page resources below a root resource (incl. queries/sort).
long countResources(String rootRid, FindDescriptor findDescriptor)
Count resources below a root resource (incl. queries/sort).
OrderMechanism getCollectionOrderMechanism(String rid)
Returns the order mechanism of a collection.
LinkDescriptor getLinkDescriptor(String rid)
Returns the link descriptor of a link.
Resource createCollection(String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, LockDescriptor lockDescriptor, Property[] properties, OrderMechanism orderMechanism, FetchGroup fetchGroup)
Create a collection.
Resource createDocument(String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, LockDescriptor lockDescriptor, Property[] properties, Content content, FetchGroup fetchGroup)
Create a document.
Resource createLink(String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, LockDescriptor lockDescriptor, Property[] properties, LinkDescriptor linkDescriptor, FetchGroup fetchGroup)
Create a link.
void deleteResource(String rid)
Deletes a resource.
Resource copyResource(String rid, String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, boolean includeSubtree, FetchGroup fetchGroup)
Copy a resource.
Resource moveResource(String rid, String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, FetchGroup fetchGroup)
Move a resource.
void setCollectionOrderMechanism(String rid, OrderMechanism orderMechanism)
Change the order mechanism of a collection.
void reorderCollection(String rid, OrderOperation[] orderOperations)
Reorder children of a resource collection.
void setLinkDescriptor(String rid, LinkDescriptor linkDescriptor)
Changes the link type and/or target.

Complex types for Aspect Namespace
Collator Collator
CollatorEntry Collator entry
FindDescriptor Find descriptor
LinkDescriptor Link descriptor
OrderMechanism Order mechanism
OrderOperation Order operation
OrderPosition Order position
Not supported yet Query expression
ResourcesChunk Resources Chunk

Method and Parameters Details for Aspect Namespace

findResources

public Resource[] findResources(String rootRid, FindDescriptor findDescriptor, boolean includeInvalidResources, FetchGroup fetchGroup)

Find resources below a root resource matching certain criteria specified in the find descriptor, e.g. only child nodes or all sub nodes, normal resources or also versioned resources and so on. Additionally queries and collators can be applied.

Parameters:
Returns:
Throws:

findResourcesFirstChunk

public ResourcesChunk findResourcesFirstChunk(String rootRid, FindDescriptor findDescriptor, boolean includeInvalidResources, FetchGroup fetchGroup, long timeout, int count)

Initiate the operation to find resources below a root resource matching certain criteria specified in the find descriptor, e.g. only child nodes or all sub nodes, normal resources or also versioned resources and so on. Additionally queries and collators can be applied. When making the call, you will have to specify a timeout. Only for the given time, the result for this call will be available for chunked retrieval at the server site. A token for accessing this result will be returned and must be used.

Parameters:
Returns:
Throws:

findResourcesNextChunk

public ResourcesChunk findResourcesNextChunk(String token, int count)

Get next page of found resources below a root resource matching certain criteria specified in the find descriptor, e.g. only child nodes or all sub nodes, normal resources or also versioned resources and so on. Additionally queries and collators can be applied. When making the call, you will have to specify the access token retrieved during the initial call and a maximum number of next resources to be returned.

Parameters:
Returns:
Throws:

countResources

public long countResources(String rootRid, FindDescriptor findDescriptor)

Count resources below a root resource matching certain criteria specified in the find descriptor, e.g. only child nodes or all sub nodes, normal resources or also versioned resources and so on. Additionally queries and collators can be applied. Their number will be returned.

Parameters:
Returns:
Throws:

getCollectionOrderMechanism

public OrderMechanism getCollectionOrderMechanism(String rid)

Returns the order mechanism of a collection.

Parameters:
Returns:
Throws:

getLinkDescriptor

public LinkDescriptor getLinkDescriptor(String rid)

Returns the link descriptor of a link.

Parameters:
Returns:
Throws:

createCollection

public Resource createCollection(String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, LockDescriptor lockDescriptor, Property[] properties, OrderMechanism orderMechanism, FetchGroup fetchGroup)

Create a collection.

Parameters:
Returns:
Throws:

createDocument

public Resource createDocument(String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, LockDescriptor lockDescriptor, Property[] properties, Content content, FetchGroup fetchGroup)

Create a document.

Parameters:
Returns:
Throws:

createLink

public Resource createLink(String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, LockDescriptor lockDescriptor, Property[] properties, LinkDescriptor linkDescriptor, FetchGroup fetchGroup)

Create a link.

Parameters:
Returns:
Throws:

deleteResource

public void deleteResource(String rid)

Deletes a resource (collection, document or link). If the resource is a collection then all children will be deleted ("deep delete"). This deep method is not atomic, although each single delete of a "deep delete" must be atomic. If the resource is versioned it is up to the repositoy implementation to decide whether to delete the complete version history and all revisions or not. Usually the revisions and version history should be preserved.

Parameters:
Returns:
Throws:

copyResource

public Resource copyResource(String rid, String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, boolean includeSubtree, FetchGroup fetchGroup)

Copies a resource (collection, document or link). If the resource is a collection then includeSubtree determines whether or not all children will be copied ("deep copy"). This deep method is not atomic, although each single copy of a "deep copy" must be atomic. If the resource is versioned it is up to the repositoy implementations to copy the complete version history and all revisions or not. Usually the revisions and version history should be preserved.

Parameters:
Returns:
Throws:

moveResource

public Resource moveResource(String rid, String parentCollectionRid, String childName, OrderPosition orderPosition, boolean overwriteEnforced, FetchGroup fetchGroup)

Moves a resource (collection, document or link). If the resource is a collection then all children will be moved ("deep move"). This deep method is not atomic, although each single copy of a "deep move" must be atomic. If the resource is versioned it is up to the repositoy implementations to move the complete version history and all revisions or not. Usually the revisions and version history should be preserved.

Parameters:
Returns:
Throws:

setCollectionOrderMechanism

public void setCollectionOrderMechanism(String rid, OrderMechanism orderMechanism)

Change the order mechanism of a collection.

Parameters:
Returns:
Throws:

reorderCollection

public void reorderCollection(String rid, OrderOperation[] orderOperations)

Reorder children of a resource collection. The children of the resource collection will be rearranged according to the given list of order operations for the children of the resource with the given identifier.

Parameters:
Returns:
Throws:

setLinkDescriptor

public void setLinkDescriptor(String rid, LinkDescriptor linkDescriptor)

Changes the link type and/or target.

Parameters:
Returns:
Throws:

Complex Type Details for Aspect Namespace

Collator

A collator is used to sort resources by certain criteria and is build of ordered collator entries.

Fields and Constants
CollatorEntry[] collatorEntries Field: Collator entries

CollatorEntry

A collator entry is used to sort resources by a specific criterion, e.g. alphabetically by a certain property value.

Fields and Constants
String name Field: Name
boolean ascending Field: Ascending

FindDescriptor

A find descriptor defines the resources to be returned in a find resources call, e.g. only direct children (one hierarchy level) or all children (all hierarchy levels).

Fields and Constants
QueryExpression queryExpression Not supported yet
Collator collator Field: Collator (Optional)
int depth Field: Depth (0: retrieve the specified resource itself, 1: retrieve the children of the specified resource, 2:retrieve the whole subtree of the specified resource)
boolean versioned Field: Versioned

LinkDescriptor

A link descriptor describes a link, e.g. by referencing another resource by RID.

Fields and Constants
int type Field: Type
" TYPE_URL Constant with value 1: URL type (not updated when resource moved)
" TYPE_RID Constant with value 2: RID type (not updated when resource moved)
String targetUrl Field: Target URL (Optional)
String targetRid Field: Target RID (Optional)

OrderMechanism

An order mechanism defines the order of child resources inside of collections, e.g. manual (reordering is possible) or server (order is fixed by whatever the server decides on).

Fields and Constants
int type Field: Type (Optional)
" TYPE_DEFAULT Constant with value 0: Default type (implementation specific)
" TYPE_UNORDERED Constant with value 1: Unordered type (order may change without notice)
" TYPE_MANUAL Constant with value 2: Manual type (user defines order by manual reorders)
" TYPE_SERVER Constant with value 3: Server type (server defines order by internal impl)

OrderOperation

An order operation is used to reorder a resource in a collection.

Fields and Constants
String resourceName Field: Name of resource to be reordered
OrderPosition orderPosition Field: New order position

OrderPosition

An order position is used to define the order of a resource in a collection.

Fields and Constants
int type Field: Type (Optional)
" TYPE_DEFAULT Constant with value 0: Default type (implementation specific)
" TYPE_FIRST Constant with value 1: Used to make resource first resource
" TYPE_LAST Constant with value 2: Used to make resource last resource
" TYPE_BEFORE Constant with value 3: Used to insert resource before reference resource
" TYPE_AFTER Constant with value 4: Used to insert resource after reference resource
String referenceResourceName Field: Name of referenced resource (Optional)

QueryExpression

Queries are not supported yet.

Fields and Constants
String queryExpression Not supported yet

ResourcesChunk

A chunk of resources returned in a call returning multiple resources. A chunk of anything is used by certain calls possibly returning too much data. Such calls are offered in chunked versions, returning the first chunk of data and then the next chunks of data with each subsequent call. The first chunk holds a token which must be used to make the subsequent calls. Based on this token the next data can be fetched if still available. Data may no longer be available if the memory got low or the token expired (defined by configuration settings - see config aspect).

Fields and Constants
String token Field: Access token
boolean lastChunk Field: Flag informing whether or not this was the last chunk
Resource[] resourcesChunk Field: Resources chunk

Property Aspect

This aspect covers property operations. Properties are bits of information attached to a resource. They have a name, are of a predefined type, e.g. boolean or string and have one or multiple values. Retrieving all properties of a resource is an example of reading - setting a new property is an example of writing.

Methods and Parameters for Aspect Property
Property getProperty(String rid, String propertyName)
Get single prop of a single rid.
Property[] getProperties(String rid, String[] propertyNames)
Get array of props of a single rid.
Property[] getAllProperties(String rid)
Get array of all props of a single rid.
PropertyBag[] getPropertyMass(String[] rids, String propertyName)
Get single prop of an array of rids.
PropertyBag[] getPropertiesMass(String[] rids, String[] propertyNames)
Get array of props of an array of rids.
PropertyBag[] getAllPropertiesMass(String[] rids)
Get array of all props of an array of rids.
void setProperty(String rid, Property property)
Set single prop on a single rid.
void setProperties(String rid, Property[] properties)
Set array of props on a single rid.
void setAllProperties(String rid, Property[] properties)
Set array of props on a single rid deleting all others.
void setPropertyMass(String[] rids, Property property)
Set single prop on an array of rids.
void setPropertiesMass(String[] rids, Property[] properties)
Set array of props on an array of rids.
void setAllPropertiesMass(String[] rids, Property[] properties)
Set array of props on an array of rids deleting all others.
void deleteProperty(String rid, String propertyName)
Delete single prop on a single rid.
void deleteProperties(String rid, String[] propertyNames)
Delete array of props on a single rid.
void deleteAllProperties(String rid)
Delete all props on a single rid.
void deletePropertyMass(String[] rids, String propertyName)
Delete single prop on an array of rids.
void deletePropertiesMass(String[] rids, String[] propertyNames)
Delete array of props on an array of rids.
void deleteAllPropertiesMass(String[] rids)
Delete all props on an array of rids.

Complex types for Aspect Property
Property Property
PropertyBag Property bag

Method and Parameters Details for Aspect Property

getProperty

public Property getProperty(String rid, String propertyName)

Get single property of a single rid. Returns a null if the property is not set.

Parameters:
Returns:
Throws:

getProperties

public Property[] getProperties(String rid, String[] propertyNames)

Get array of properties of a single rid. Returns a null for every property not set (the order of all properties is preserved).

Parameters:
Returns:
Throws:

getAllProperties

public Property[] getAllProperties(String rid)

Get array of all properties of a single rid. Returns an empty array if no properties are available.

Parameters:
Returns:
Throws:

getPropertyMass

public PropertyBag[] getPropertyMass(String[] rids, String propertyName)

Get single property of an array of rids (mass call). Returns a null for each resource not having this property. A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

getPropertiesMass

public PropertyBag[] getPropertiesMass(String[] rids, String[] propertyNames)

Get array of properties of an array of rids (mass call). Returns a null for every property per resource not set (the order of all properties is preserved). A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

getAllPropertiesMass

public PropertyBag[] getAllPropertiesMass(String[] rids)

Get array of all properties of an array of rids (mass call). Returns an empty property list for each resource not having any properties. A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

setProperty

public void setProperty(String rid, Property property)

Set single property on a single rid.

Parameters:
Returns:
Throws:

setProperties

public void setProperties(String rid, Property[] properties)

Set array of properties on a single rid.

Parameters:
Returns:
Throws:

setAllProperties

public void setAllProperties(String rid, Property[] properties)

Set array of properties on a single rid deleting all other custom properties.

Parameters:
Returns:
Throws:

setPropertyMass

public void setPropertyMass(String[] rids, Property property)

Set single property on an array of rids (mass call). A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

setPropertiesMass

public void setPropertiesMass(String[] rids, Property[] properties)

Set array of properties on an array of rids (mass call). A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

setAllPropertiesMass

public void setAllPropertiesMass(String[] rids, Property[] properties)

Set array of properties on an array of rids (mass call) deleting all other custom properties. A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

deleteProperty

public void deleteProperty(String rid, String propertyName)

Delete single property on a single rid.

Parameters:
Returns:
Throws:

deleteProperties

public void deleteProperties(String rid, String[] propertyNames)

Delete array of properties on a single rid.

Parameters:
Returns:
Throws:

deleteAllProperties

public void deleteAllProperties(String rid)

Delete all custom properties on a single rid.

Parameters:
Returns:
Throws:

deletePropertyMass

public void deletePropertyMass(String[] rids, String propertyName)

Delete single property on an array of rids (mass call). A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

deletePropertiesMass

public void deletePropertiesMass(String[] rids, String[] propertyNames)

Delete array of properties on an array of rids (mass call). A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

deleteAllPropertiesMass

public void deleteAllPropertiesMass(String[] rids)

Delete all custom properties on an array of rids (mass call). A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

Complex Type Details for Aspect Property

Property

A property is a bit of information attached to a resource. They have a name, are of a predefined type, e.g. boolean or string, have one or multiple values and additional flags describing them. The value is transported in a string (Booleans are expressed by true/false; Dates are expressed in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'). Multiple values are also stored in this single string field and separated by comma, where the forward slash is the escape character for the comma and itself.

Fields and Constants
int type Field: Type
" TYPE_BOOLEAN Constant with value 1: Boolean type
" TYPE_DATE Constant with value 2: Date type
" TYPE_INTEGER Constant with value 3: Integer type
" TYPE_LONG Constant with value 4: Long type
" TYPE_STRING Constant with value 5: String type
" TYPE_XML Constant with value 6: Xml type
String namespace Field: Namespace (used to group properties) (Optional)
String localName Field: Local name (specific name) (Optional)
String propertyName Field: Property name (concatentated namespace and local name)
String value Field: Value (Optional)
boolean multivalued Field: Multivalued
boolean required Field: Required (necessary for resource)
boolean live Field: Live (dependent/determined by live data, e.g. content)
boolean readonly Field: Readonly (hint for UIs)
boolean hidden Field: Hidden (hint for UIs)
String description Field: Description (Optional)

PropertyBag

A property bag holds multiple properties.

Fields and Constants
Property[] properties Field: List of properties

Content Aspect

This aspect covers content operations. Content is stored in a byte array and only documents may have content. When a content is set, certain properties are set along with, e.g. the content length or type. Thoose properties are also available as one single object, the content metadata object. Retrieving content or content metadata is an example of reading - setting content is an example of writing.

Methods and Parameters for Aspect Content
Content getContent(String rid)
Get content for a resource.
ContentMetadata getContentMetadata(String rid)
Get content metadata for a resource.
ContentChunk getContentFirstChunk(String rid, int length, long timeout)
Get first chunk of content for a resource.
ContentChunk getContentNextChunk(String token, int length)
Get next chunk of content for a resource.
void setContent(String rid, Content content)
Set content for a resource.
String setContentFirstChunk(String rid, ContentChunk contentChunk, long timeout)
Set first chunk of content for a resource.
void setContentNextChunk(ContentChunk contentChunk)
Set next chunk of content for a resource.

Complex types for Aspect Content
Content Content
ContentChunk Content chunk
ContentMetadata Content metadata

Method and Parameters Details for Aspect Content

getContent

public Content getContent(String rid)

Get content for a resource.

Parameters:
Returns:
Throws:

getContentMetadata

public ContentMetadata getContentMetadata(String rid)

Get content metadata for a resource.

Parameters:
Returns:
Throws:

getContentFirstChunk

public ContentChunk getContentFirstChunk(String rid, int length, long timeout)

Get first chunk of content for a resource. When making the call, you will have to specify the maximum amount of a data to be transmitted and a timeout. Only for the given time, the content for this call will be available for chunked retrieval at the server site. A token for accessing this result will be returned (with the content chunk) and must be used.

Parameters:
Returns:
Throws:

getContentNextChunk

public ContentChunk getContentNextChunk(String token, int length)

Get next chunk of content for a resource. When making the call, you will have to specify the maximum amount of a data to be transmitted and the access token received when making the initial call.

Parameters:
Returns:
Throws:

setContent

public void setContent(String rid, Content content)

Set content for a resource. The metadata of the content will be updated atomically during the set call if supported by the repository manager (e.g. for etag and last-modified-by timestamp).

Parameters:
Returns:
Throws:

setContentFirstChunk

public String setContentFirstChunk(String rid, ContentChunk contentChunk, long timeout)

Set first chunk of content for a resource. When making the call, you will have to specify a timeout. Only for the given time, the operation will wait for the next content chunk at the server site. A token for accessing this operation will be returned and must be used. The metadata of the content will be updated atomically during the last chunked call if supported by the repository manager (e.g. for etag and last-modified-by timestamp).

Parameters:
Returns:
Throws:

setContentNextChunk

public void setContentNextChunk(ContentChunk contentChunk)

Set next chunk of content for a resource. When making the call, you will have to specify the access token received when making the initial call. The metadata of the content will be updated atomically during the last chunked call if supported by the repository manager (e.g. for etag and last-modified-by timestamp).

Parameters:
Returns:
Throws:

Complex Type Details for Aspect Content

Content

A content object stores the concrete data of document.

Fields and Constants
ContentMetadata metadata Field: Content metadata
byte[] content Field: Content

ContentChunk

A chunk of content returned in a call returning possibly huge content. A chunk of anything is used by certain calls possibly returning too much data. Such calls are offered in chunked versions, returning the first chunk of data and then the next chunks of data with each subsequent call. The first chunk holds a token which must be used to make the subsequent calls. Based on this token the next data can be fetched if still available. Data may no longer be available if the memory got low or the token expired (defined by configuration settings - see config aspect).

Fields and Constants
String token Field: Access token
boolean lastChunk Field: Flag informing whether or not this was the last chunk
byte[] contentChunk Field: Content chunk
ContentMetadata contentMetadata Field: Content metadata

ContentMetadata

A content metadata object defines the properties of a content object, e.g. its length or type.

Fields and Constants
long length Field: Length
String type Field: Type (Optional)
String encoding Field: Encoding (Optional)
String language Field: Language (Optional)
String eTag Field: E tag (Optional)
Date expires Field: Expires (Optional)
Date lastModified Field: Last modified (Optional)

Lock Aspect

This aspect covers lock operations. Locking a resource helps synchronizing on resources. Different locks are available, e.g. for reading or writing and can be set or removed. Locks have a timeout in order to automatically free resources. Getting all locks on a resource is an example of reading - aquiring a lock on a resource is an example of writing.

Methods and Parameters for Aspect Lock
LockInfo[] getLocks(String rid)
Get array of lock infos describing all locks set.
LockInfoBag[] getLocksMass(String[] rids)
Get array of lock infos of an array of rids.
LockInfo lock(String rid, LockDescriptor lockDescriptor)
Lock a resource for access according to the lock descriptor.
void unlock(String rid, String lockToken)
Unlock a resource based on the used lock token.
LockInfo refreshLock(String rid, String lockToken)
Refresh a lock for a resource.

Complex types for Aspect Lock
LockDescriptor Lock descriptor
LockInfo Lock info
LockInfoBag Lock info bag

Method and Parameters Details for Aspect Lock

getLocks

public LockInfo[] getLocks(String rid)

Get array of lock infos describing all locks set for the given resource identifier independently of the user. Returns also deep locks of parent resources if set above the given resource. Returns an empty array if no locks are found for the resource.

Parameters:
Returns:
Throws:

getLocksMass

public LockInfoBag[] getLocksMass(String[] rids)

Get array of lock infos of an array of rids (mass call). Returns an empty lock info list for each resource not having any lock infos. A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

lock

public LockInfo lock(String rid, LockDescriptor lockDescriptor)

Lock a resource for access according to the lock descriptor.

Parameters:
Returns:
Throws:

unlock

public void unlock(String rid, String lockToken)

Unlock a resource based on the used lock token.

Parameters:
Returns:
Throws:

refreshLock

public LockInfo refreshLock(String rid, String lockToken)

Refresh a lock for a resource, i.e. reset the timer of the given lock for a given resource identifier until the lock is released automatically.

Parameters:
Returns:
Throws:

Complex Type Details for Aspect Lock

LockDescriptor

A lock descriptor object describes how a lock on a resource should be aquired, e.g. defining its properties.

Fields and Constants
int type Field: Type of lock
" TYPE_READ Constant with value 1: Lock for read operations
" TYPE_WRITE Constant with value 2: Lock for write operations
int depth Field: Depth of lock
" DEPTH_SHALLOW Constant with value 1: Effects only this resource
" DEPTH_DEEP Constant with value 2: Effects this and all resources below this resource
int scope Field: Scope of lock
" SCOPE_SHARED Constant with value 1: Other locks can be obtained as well
" SCOPE_EXCLUSIVE Constant with value 2: No other locks can be obtained
long timeout Field: Timeout of lock

LockInfo

A lock info object defines a resource lock, e.g. its identifier for subsequent calls.

Fields and Constants
int type Field: Type of lock
" TYPE_READ Constant with value 1: Lock for read operations
" TYPE_WRITE Constant with value 2: Lock for write operations
int depth Field: Depth of lock
" DEPTH_SHALLOW Constant with value 1: Effects only this resource
" DEPTH_DEEP Constant with value 2: Effects this and all resources below this resource
int scope Field: Scope of lock
" SCOPE_SHARED Constant with value 1: Other locks can be obtained as well
" SCOPE_EXCLUSIVE Constant with value 2: No other locks can be obtained
long timeout Field: Timeout of lock
String token Field: Access token
Date creationDate Field: Creation date
Date expirationDate Field: Expiration date
String owner Field: Owner

LockInfoBag

A lock info bag holds multiple lock infos.

Fields and Constants
LockInfo[] lockInfos Field: List of lock infos

Security Aspect

This aspect covers security operations. When a read or write operation on an aspect is called the caller must have certain permissions to do so, e.g. user A may read, but may not create new resources. These permissions can be queried or set using this aspect. Checking for a certain permission for a user is an example of reading - setting the permission for a certain user is an example of writing, but not yet supported.

Methods and Parameters for Aspect Security
Permission[] getSupportedPermissions(String rid)
Get array of permissions which are supported.
boolean isAllowed(String rid, String permissionName)
Checks if user has permission on resource identifier.
boolean isAllowedSet(String rid, String[] permissionNames)
Checks if user has permissions on resource identifier.
boolean[] isAllowedMass(String[] rids, String permissionName)
Checks if user has permission on resource identifiers.
boolean[] isAllowedSetMass(String[] rids, String[] permissionNames)
Checks if user has permissions on resource identifiers.

Complex types for Aspect Security
Permission Permission

Method and Parameters Details for Aspect Security

getSupportedPermissions

public Permission[] getSupportedPermissions(String rid)

Get array of permissions which are supported by the security manager for the given resource identifier. The outcome depends on the underlying repository and other issues like e.g. the resources nature (collection or not).

Parameters:
Returns:
Throws:

isAllowed

public boolean isAllowed(String rid, String permissionName)

Checks whether the logged in user has the given permission on the given resource identifier.

Parameters:
Returns:
Throws:

isAllowedSet

public boolean isAllowedSet(String rid, String[] permissionNames)

Checks whether the logged in user has all of the given permissions on the given resource identifier. All the permissions must be granted to the user, otherwise a false return value is delivered.

Parameters:
Returns:
Throws:

isAllowedMass

public boolean[] isAllowedMass(String[] rids, String permissionName)

Checks whether the logged in user has the given permission on the given resource identifiers (mass call). A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

isAllowedSetMass

public boolean[] isAllowedSetMass(String[] rids, String[] permissionNames)

Checks whether the logged in user has all of the given permissions on the given resource identifiers (mass call). All the permissions must be granted to the user, otherwise a false return value is delivered. A mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceoptions carried along with the partially computed results (also ordered).

Parameters:
Returns:
Throws:

Complex Type Details for Aspect Security

Permission

A permission is the name of an access right. Users may or may not have certain access rights on resources. These access rights can be queried by providing the requested permission and user along with a call.

Fields and Constants
String name Field: Name
String description Field: Description (Optional)

Version Aspect

This aspect covers version operations. Resources can be set under version control, meaning that all changes to the resources can be tracked. Only checked out resources can be modified and all changes will be collected and assigned to the revision given back by the system when checking the resource in again. Querying the revision history is an example of reading - checking a resource in is an example of writing.

Methods and Parameters for Aspect Version
boolean isVersionControlEnabled(String rid)
Check if a resource is a version controlled resource.
void setVersionControlEnabled(String rid, boolean enabled)
Enable or disable version control for a resource.
Resource[] getVersionHistory(String rid, FetchGroup fetchGroup)
Get version history for a version controlled resource.
String getRevisionId(String rid)
Get revision id for a version controlled resource.
boolean isCheckedOut(String rid)
Check if a resource is a checked out.
CheckOutInfo checkOut(String rid)
Check out a checked-in version controlled resource.
void undoCheckOut(String rid)
Roll back a previous checkout operation.
CheckInInfo checkIn(String rid, Property[] properties, Content content)
Check in a checked-out version controlled resource.

Complex types for Aspect Version
CheckInInfo Check in info
CheckOutInfo Check out info

Method and Parameters Details for Aspect Version

isVersionControlEnabled

public boolean isVersionControlEnabled(String rid)

Check if a resource identifier denotes a version controlled resource.

Parameters:
Returns:
Throws:

setVersionControlEnabled

public void setVersionControlEnabled(String rid, boolean enabled)

Enable or disable version control for a resource referred by the given resource identifier. Depending on the implementation and configuration of the repository, the version history of a version controlled resource may be lost when version control is disabled on the resource.

Parameters:
Returns:
Throws:

getVersionHistory

public Resource[] getVersionHistory(String rid, FetchGroup fetchGroup)

If the given resource identifier refers to a version controlled resource with a linear version history, this version history is returned as an array of resources referring to version resources. Note that the last version in the array is the newest.

Parameters:
Returns:
Throws:

getRevisionId

public String getRevisionId(String rid)

If the given resource identifier refers to a version controlled resource, the revision id is returned.

Parameters:
Returns:
Throws:

isCheckedOut

public boolean isCheckedOut(String rid)

Check if a resource identifier denotes a checked out version controlled resource.

Parameters:
Returns:
Throws:

checkOut

public CheckOutInfo checkOut(String rid)

Check out a checked-in version controlled resource to prepare subsequent changes of it's version controlled state. These changes may be persisted in a newly created version by a subsequent call to checkIn(), or they may be rolled back by a subsequent call to undoCheckOut().

Parameters:
Returns:
Throws:

undoCheckOut

public void undoCheckOut(String rid)

Roll back a previous checkout operation.

Parameters:
Returns:
Throws:

checkIn

public CheckInInfo checkIn(String rid, Property[] properties, Content content)

Check in a checked-out version controlled resource to create a new version describing the current version controlled state of the version controlled resource. The 'state' of the new version will be initialized from the current 'state' of the given check in data, where 'state' is defined to consist of content, dead properties and - in the case of a version controlled collection - the set of version controlled bindings of the collection together with ordering information.

Parameters:
Returns:
Throws:

Complex Type Details for Aspect Version

CheckInInfo

A check-in info object defines the information returned back after a check-in, e.g. the effective revision id. When a resource is checked out, the expected revision id will be the actual revision id incremented by 1. When another one checks in the same resource before you have, your effective revision id will be different from the expected one. When you compare them and find about this you may be forced to resolve your changes. This can be prevented by locking the resource before checking it out and holding the lock until check-in.

Fields and Constants
String effectiveRevisionRid Field: Effective revision rid
String effectiveRevisionId Field: Effective revision id

CheckOutInfo

A check-out info object defines the information returned back after a check-out, e.g. the expected revision id. When a resource is checked out, the expected revision id will be the actual revision id incremented by 1. When another one checks in the same resource before you have, your effective revision id will be different from the expected one. When you compare them and find about this you may be forced to resolve your changes. This can be prevented by locking the resource before checking it out and holding the lock until check-in.

Fields and Constants
String expectedRevisionRid Field: Expected revision rid
String expectedRevisionId Field: Expected revision id

PerfRF Aspect

This aspect covers performance issues and is needed for Web Service maintenance purposes only. Performance information supports developers in using and optimizing the Web Service. Among other information the processing time (on average/last call) or failure rate (number of caught exceptions in relation to number of made calls) can be queried per Web Service method.

Methods and Parameters for Aspect PerfRF
PerfStoreRF getGlobalPerf()
Get global performance data.
void resetGlobalPerf()
Reset global performance data.
PerfStoreRF getSessionPerf()
Get session performance data.
void resetSessionPerf()
Reset session performance data.
PingDataRF ping(int calls, int threads)
Return immediately or re-ping given number of times.

Complex types for Aspect PerfRF
PerfStoreRF Performance store
PerfOnBeanRF Performance on bean
PerfOnMethodRF Performance on method
PingDataRF Ping data

Method and Parameters Details for Aspect PerfRF

getGlobalPerf

public PerfStoreRF getGlobalPerf()

Get global performance data.

Returns:
Throws:

resetGlobalPerf

public void resetGlobalPerf()

Reset global performance data.

Returns:
Throws:

getSessionPerf

public PerfStoreRF getSessionPerf()

Get session performance data.

Returns:
Throws:

resetSessionPerf

public void resetSessionPerf()

Reset session performance data.

Returns:
Throws:

ping

public PingDataRF ping(int calls, int threads)

Return immediately or re-ping given number of times.

Parameters:
Returns:
Throws:

Complex Type Details for Aspect PerfRF

PerfStoreRF

A performance store object holds information on all meassured performance information bits of the Web Service.

Fields and Constants
int scope Field: Scope
" SCOPE_GLOBAL Constant with value 1: Global
" SCOPE_SESSION Constant with value 2: Session
PerfOnBeanRF perfOnBean Field: Performance on bean
PerfOnMethodRF[] perfOnMethods Field: Performance on methods

PerfOnBeanRF

A performance-on-bean object holds information on the bean used to implement the Web Service.

Fields and Constants
long createCount Field: Create count
long setSessionContextCount Field: Set session context count
long removeCount Field: Remove count
long activateCount Field: Activate count
long passivateCount Field: Passivate count

PerfOnMethodRF

A performance-on-method object holds information on all meassured performance information bits of a single Web Service method.

Fields and Constants
String name Field: Name
long allCallCount Field: All call count
long allFailureCount Field: All failure count
double allFailureRate Field: All failure rate
long allRuntimeOverall Field: All runtime overall
double allRuntimeAverage Field: All runtime average
double allThroughputAverage Field: All throughput average
Date lastBegintime Field: Last begintime
Date lastEndtime Field: Last endtime
long lastRuntime Field: Last runtime
String lastFailure Field: Last failure

PingDataRF

A ping data object holds information retrieved during a ping call. e.g. made for round-trip time evaluation purposes.

Fields and Constants
long callCount Field: Call count
Date begintime Field: Begintime
Date endtime Field: Endtime
long runtimeOverall Field: Runtime overall
double runtimeAverage Field: Runtime average
double throughputAverage Field: Throughput average
String failure Field: Failure

CfgRF Aspect

This aspect covers config operations and is needed for Web Service maintenance purposes only. Configuration settings define various runtime properties of the Web Service. Among other settings performance measurement can be switched on or off.

Methods and Parameters for Aspect CfgRF
CfgStoreRF getGlobalCfg()
Get the actual configuration.
CfgStoreRF setGlobalCfg(CfgStoreRF cfgStore)
Set and afterwards get the actual configuration.
BuildInfoRF getBuildInfo()
Get build info listing information available from build.

Complex types for Aspect CfgRF
CfgStoreRF Config store
BuildInfoRF Build info

Method and Parameters Details for Aspect CfgRF

getGlobalCfg

public CfgStoreRF getGlobalCfg()

Get the actual configuration.

Returns:
Throws:

setGlobalCfg

public CfgStoreRF setGlobalCfg(CfgStoreRF cfgStore)

Set and afterwards get the actual configuration.

Parameters:
Returns:
Throws:

getBuildInfo

public BuildInfoRF getBuildInfo()

Get build info object listing all information available during the build of this shipment.

Returns:
Throws:

Complex Type Details for Aspect CfgRF

CfgStoreRF

A config store object holds all configuration settings for the Web Service.

Fields and Constants
boolean perfActive Field: Performance meassuring active
boolean traceActive obsolete
boolean netconActive obsolete
long contentSizeLimit Field: Content size limit
long tokenLifetimeLimit Field: Token lifetime limit

BuildInfoRF

A build info object lists all information available during the build of this shipment and helps to answer questions like what, when, where or by whom has this shipment been build.

Fields and Constants
String releaseName Field: Release name
String projectName Field: Project name
String subprojectName Field: Subproject name
String buildDate Field: Build date
String buildChangelist Field: Build changelist
String buildServer Field: Build server
String buildLocation Field: Build location
String modelDate Field: Model date
String modelChangelist Field: Model changelist
String modelRevision Field: Model revision
String japroInfo Field: Japro info
String manifestInfo Field: Manifest info
String modelDefintion Field: Model defintion

Exceptions

OperationFailedException Basic exception indicating a failed Web Service operation.
InvalidParameterException Exception indicating a parameter value constraint violation.
IncompleteLookupOperationException Operation on multiple resources in lookup call failed.
IncompletePropertyOperationException Operation on multiple resources in property call failed.
IncompletePropertyBagOperationException Operation on multiple resources in property bag call failed.
IncompleteLockInfoBagOperationException Operation on multiple resources in lock info bag call failed.
IncompleteSecurityOperationException Operation on multiple resources in security bag call failed.

OperationFailedException

This exception indicates a Web Service operation failure in general. It consists of a message text, an exception name and a call stack.

Fields and Constants
String messageText Field: Message text (message text of caught exception)
String exceptionName Field: Exception name (exception name of caught exception)
String callStack Field: Call stack (call stack of caught exception)

InvalidParameterException

Exception indicating a parameter value constraint violation. Either a field contained no valid value or the combination of field values was not allowed for this parameter.

Fields and Constants
String messageText Field: Message text (message text describing constraint violation)
String methodSignature Field: Method signature (method signature w. constraint violation)
String parameterName Field: Parameter name (parameter name causing constraint violation)

IncompleteLookupOperationException

This exception indicates a lookup mass call handling resources failed partly (e.g. lookup of multiple resources). A mass call operation failed partly - a mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceptions carried along with the partially computed results (also ordered).

Fields and Constants
Resource[] resources Field: Resources
OperationFailedException[] exceptions Field: Exceptions

IncompletePropertyOperationException

This exception indicates a property mass call handling properties failed partly (e.g. get a property of multiple resources). A mass call operation failed partly - a mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceptions carried along with the partially computed results (also ordered).

Fields and Constants
Property[] properties Field: Properties
OperationFailedException[] exceptions Field: Exceptions

IncompletePropertyBagOperationException

This exception indicates a property mass call handling properties failed partly (e.g. get all properties of multiple resources). A mass call operation failed partly - a mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceptions carried along with the partially computed results (also ordered).

Fields and Constants
PropertyBag[] propertyBags Field: Property bags
OperationFailedException[] exceptions Field: Exceptions

IncompleteLockInfoBagOperationException

This exception indicates a lock mass call handling locks failed partly (e.g. get all lock infos of multiple resources). A mass call operation failed partly - a mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceptions carried along with the partially computed results (also ordered).

Fields and Constants
LockInfoBag[] lockInfoBags Field: Lock info bags
OperationFailedException[] exceptions Field: Exceptions

IncompleteSecurityOperationException

This exception indicates a security mass call handling permissions failed partly (e.g. permission check on multiple resources). A mass call operation failed partly - a mass call executes a single operation on multiple resources. When the operation failes for a single resource, the mass call will continue its execution, but at the end an IncompleteOperationException will be thrown, providing the partially computed results and the caught exceptions. The partially computed results are ordered (as defined by the ingoing parameters) and nulls have been inserted for each operation failed on a resource. For each null the caught exception is stored inside the list of exceptions carried along with the partially computed results (also ordered).

Fields and Constants
Boolean[] allowances Field: Allowances
OperationFailedException[] exceptions Field: Exceptions

Copyright 2007 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.