SAP NetWeaver '04

Package com.sapportals.wcm.repository

Contains the repository framework interfaces and classes.

See:
          Description

Interface Summary
IBindableResource Interface for bindable resources (see WebDAV BIND protocol ).
IBindController Interface for collections that can explicitly control the bindings they contain (see WebDAV BIND protocol ).
ICheckInInfo Holds status information returned upon a successfull check-in.
ICheckInInfo2 Holds status information returned upon a successfull check-in.
ICheckOutInfo Holds status information returned upon a successfull check-out.
ICheckOutInfo2 Holds status information returned upon a successfull call to IVersionControlledResource.checkOut(boolean, boolean) or IVersionResource.checkOut(boolean) or Copyright 2002 (c) SAP AG
ICollection A collection is a resource (IResource) that contains other resources and collections following the composite pattern.
ICollectionVersionResource Interface for collection version (revision) resources.
ICompletedResourceList A typed list of IResource instances.
IContentResource Interface for extended support of resource content.
ICopyParameter Parameter collection for the copy() and move() methods in IResource and ICollection.
IEntityMetadata Additional content meta data.
IExtendedCollection Extended interface for collections, providing
- extended link creation methods.
IExtendedLockInfo Additional information about a lock.
IExternalLinkResource Interface for external link resources.
IInternalLinkResource Extended interface for internal link resources.
ILink A WCM link is used to create links to repository resources and URL resources on external servers.
ILockInfo Information about a specific lock.
ILockInfoCollection This interface defines a collection of ILockInfo instances
ILockInfoIterator This interface defines a iterator for collections of ILockInfo instances.
ILockProperties A container for the properties of a lock.
IMultiValueQueryBuilder Builder for queries that operate on multi-valued properties.
IMutableEntityMetadata Interfaces for updates on those parts of content metadata that change when the content is actually persisted by the repository manager.
IMutableProperty A property of a resource object with a mutable interface.
IMutablePropertyMap An extention of the IPropertyMap interface with methods to modify the map.
IOrderableCollection Interfaces for collections that support ordering.
IPosition The positioning information required by methods that position resource in ordered collections.
IPositioning This interface defines a container for positioning information which is used by the reorder() method in IResource Copyright (c) SAP AG 2001-2003
IProperty This interface provides read-only access to a property of a resource.
IPropertyBatch Holds the properties of multible resources.
IPropertyDef Information about the type, name and other attributes of a property.
IPropertyIterator An Iterator for a property map
IPropertyMap A read-only map of properties.
IPropertyName A property's name and namespace
IPropertyNameList This interface defines a list of IPropertyNameList objects.
IPropertyNameListIterator An Iterator for a property map
IQueryBuilder Constructs IQueryExpressions for later use with the corresponding property search manager.
IQueryExpression A query expression to be used with its property search manager.
IReorderList This interface defines a list of IPositioning objects.
IReorderListIterator An iterator for IReorderList instances.
IResource A resource represents an object in a repository and is uniquely identified by a resource identifier (RID).
IResourceClass TBD: Description of the interface.
IResourceClassIterator TBD: Description of the interface.
IResourceClassSet TBD: Description of the interface.
IResourceContext The context that contains information for all repository operations belonging to one request, session, etc.
IResourceFactory The resource factory has methods to create resource objects (IResource) and to access the manager and service factories.
IResourceList A typed list of IResource instances.
IResourceListIterator An iterator for the resource list
IResourceMetadata Extended interface for resources that provide additional meta-information.
ISupportedOptionSet TBD: Description of the interface.
ITimestampedResource Interface for resources that can report the time of creation.
ITypedResourceList A typed list of IResource instances.
IVersionControlledResource Interface for version controlled resources (see RFC3253 ).
IVersionController Interface for collections that support automatic versioning of all member resources.
IVersionHistory Interface to a list of revisions (versions) of a resource.
IVersionHistoryResource Interface for version history resources.
IVersionResource Interface for version (revision) resources (see RFC3253 ).
IWorkingResource Interface for working resources (see RFC3253 ).
IWorkspaceControlledResource Extended interface for resources under workspace control.
IWorkspaceResource Extended interface for workspace resources.
 

Class Summary
Collator  
Content Access to the content data of a resource.
ContentMetadata TBD: Description of the class.
CopyParameter Parameter collection for the copy() and move() methods in IResource and ICollection.
ExtendedLockInfo This object represents an active deep lock on a resource.
LockInfo This object represents an active lock on a resource.
LockInfoCollection Implementation of a lock info collection
LockInfoIterator Implementation of a lock info iterator
LockProperties A container for the properties of a lock.
MutableProperty A property of a resource object that can be modified
MutablePropertyMap Holds a mutable map of Property objects.
NameInfo This object contains information about the restrictions for resource and collection names of a specific repository.
Position The positioning information required by methods that position resource in ordered collections.
Positioning This is a container for positioning information which is used by the reorder() method in IResource
Property A read-only property of a resource object.
PropertyChangeResult This class is a container for the results of the IResource.setProperties methods.
PropertyChangeResultCollection A collection of property change results.
PropertyChangeResultIterator An iterator over a collection of property change results.
PropertyCollatorItem  
PropertyDef Information about the type, name and other attributes of a property.
PropertyIterator Iterator for a property map
PropertyMap Holds a read-only map of Property objects.
PropertyName The name of a resource's property.
PropertyNameList This interface defines a list of IPropertyNameList objects.
PropertyNameListIterator An iterator for PropertyNameListIterator instances.
PropertySelectorItem  
ReorderList This interface defines a list of IPositioning objects.
ReorderListIterator An iterator for IReorderList instances.
ResourceContext Instances of this class contain information about the context the client is running is (request, session, etc.)
ResourceErrors This is a collection of resource exceptions.
ResourceFactory The ResourceFactory is used to create instances of resource objects.
ResourceList Implements the IResourceList interface.
ResourceListIterator Iterator for the resource list
ResourcePropertyComparator ResourcePropertyComparator Copyright (c) SAP AG 2001-2004
Selector Copyright SAP AG 2004
SupportedOptionSet A set of supported operations for a resource
TypedResourceList Implements the ITypedResourceList interface.
XMLMarkup A property type for XML markup.
 

Exception Summary
AbstractPropertyException Abstract base class for property exceptions.
AccessDeniedException Access to a resource or property is denied because the user does not have the required authorization.
AuthorizationRequiredException The user is not authorized.
CheckedOutException The resource is checked out by another user.
ExpectedCheckInRIDException The RID of the new revision is different from the RID that the application excepted when chacking out.
ExpectedCheckInURIException Deprecated. as of NW04.
ExternalLinkException The requested RID contains an external link.
IllegalPropertyNameException Raised when a property name was not acceptable.
IncompleteOperationException An operation did not complete because of precondition failures.
InternalLinkException The requested RID contains an internal link to a collection.
InvalidArgumentException One ore more invalid values where provided for the parameters of a method.
InvalidNameException The application tried to use a invalid resource name
InvalidPositionException The required positioning was not valid (usually because the referenced collection member did not exist).
InvalidTargetException An invalid target was used for a copy or move operation.
InvalidUriException An invalid URI was used.
IOErrorException An IO error occured while trying to access a resource.
LabelAlreadyExistsException The application tried add a label that already exists in the version history.
LinkLoopException The target RID specified when creating or updating am internal link is also a link and would cause an loop.
LockedException The resource was locked by another user.
LockNotFoundException The requested lock does not exist.
MethodNotAllowedException The resource does not support the operation
NameAlreadyExistsException The application tried to use a name for a new resource that already exists in the collection.
NoContentException The resource has no content
NoRevisionException The resource is not a revision resource.
NotCheckedOutException The resource is not checked out
NotOrderedException An attempt was made to perform an ordering operation on an unordered collection.
NotSupportedException The repository manager does not support the operation.
NotVersionedException The application tried to check out a resource that is not versioned.
PropertyMandatoryException The property could not be removed because it is mandatory.
PropertyNameTooLongException Raised when a property name was too long.
PropertyReadOnlyException The property cannot be changed because it is read-only.
PropertyTypeLostException Raised when a property was set, but the repository didn't support the desired type.
PropertyTypeMismatchException Raised when an attempt was made to set a protected property with a non-applicable data type.
PropertyUnchangedException Raised when a property change couldn't be commited due to a failed dependency on another change.
PropertyValueTooBigException Raised when a property value was too big.
ResourceException Resource Exception.
ResourceIsLinkException This exception is thrown during copy or move operations if the CopyParameter has copyInternalLink or copyExternalLink set to true and links are encountered during a deep copy operation.
ResourceNotCollectionException Indicates that the resource has changed to a non-collection since the IResource object was obtained.
ResourceNotFoundException Indicates that a resource could not be found.
ResourceReadOnlyException The resource is read-only.
RevisionResourceException The operation is not available because the resource is a revision.
ServiceUnavailableException A service is not available.
SetPropertiesException This exception indicates errors during a call.
UnassignableNameException Raised when the name can not be assigned because (1) a "similar" name already exists (for instance, if "a" already exists in a case-preserving but not case-sensitive repository, and creation of "A" was attempted) or (2) the name is syntactically legal, but can not be reassigned to a new resource (stable names for versions and version histories).
VersionHasDescendantsException The checkout operation failed because the version to be checked out has descendants in it's version history and the resulting version history fork is not allowed in current context.
VersionHistoryInUseException ResourceException thrown if someone tries to create a Vcr in a workspace that already contains a vcr with the same version history.
VersionIsCheckedOutException The checkout operation failed because the version to be checked out is already the checked out version of some other version controlled resource and the resulting version history fork is not allowed in current context.
VirusContentException This exception is raised when a check reveals that content being read/written possibly contains a Virus.
 

Package com.sapportals.wcm.repository Description

Contains the repository framework interfaces and classes.


SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
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.