| Modifier and Type | Method and Description |
|---|---|
ISendMailItem |
ISendMailService.createMailItem()
Deprecated.
|
void |
ISendMailService.sendMail(IResource resource,
com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
ISendMailService.sendMail(IResource,com.sap.security.api.IUser) |
void |
ISendMailService.sendMail(IResource resource,
IUser user) |
void |
ISendMailService.sendMail(ISendMailItem mailItem,
com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
ISendMailService.sendMail(ISendMailItem,com.sap.security.api.IUser) |
void |
ISendMailService.sendMail(ISendMailItem mailItem,
IUser user) |
| Modifier and Type | Method and Description |
|---|---|
IProperty |
IRoomsStructure.getProperty(IPropertyName propertyName,
IEntryPoint entryPoint)
Returns name and description internally stored by the getEntryPoint
method.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IRelationManager.deleteRoomRelations(String roomId)
Delete all room relations to and from the given room.
|
void |
IRelationManager.deleteRoomRelations(String roomId,
String associationId)
Delete all room relations using the given relation type
to and from the given room.
|
Map |
IRelationManager.getRelatedRoomsFromRoom(String sourceRoomId)
Get all related rooms from the given room.
|
List |
IRelationManager.getRelatedRoomsFromRoom(String sourceRoomId,
String associationId)
Get all related rooms from the given room using the given relation type.
|
Map |
IRelationManager.getRelatedRoomsToRoom(String targetRoomId)
Get all related rooms to the given room.
|
List |
IRelationManager.getRelatedRoomsToRoom(String targetRoomId,
String associationId)
Get all related rooms to the given room using the given relation type.
|
void |
IRelationManager.orderRoomRelation(String sourceRoomId,
String targetRoomId,
String associationId,
IOrderedRelationPosition orderedRelationPosition)
Order room relation, i.e. place the relation from source room to target
room using the given relation type according to the given order position.
|
void |
IRelationManager.relateRoom(String sourceRoomId,
String targetRoomId,
String associationId)
Relate source room to target room using the given relation type.
|
void |
IRelationManager.unrelateRoom(String sourceRoomId,
String targetRoomId,
String associationId)
Unrelate source room from target room using the given relation type.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ClaimsKeeper.add(IClaimStaker staker)
this method will map the
PropertiesClaim to all prefixes
defined by the available IRepositoryManager instances. |
void |
Registrator.claim(IClaimStaker claimstaker) |
void |
ISerializerRegistrator.claim(IClaimStaker claimstaker)
iterates over all repositories available and calls the
claim(IClaimStaker, RID) for each of the repositories
prefixes. |
| Modifier and Type | Class and Description |
|---|---|
static class |
PropertiesCoder.PropertiesDecodeException |
| Modifier and Type | Method and Description |
|---|---|
static IProperty |
PropertiesCoder.decode(Attributes attr,
List values)
Decodes a property from the data in the XML-file
|
| Modifier and Type | Method and Description |
|---|---|
static boolean |
ArchivingUtil.isArchivingReadOnly(IResource resource,
com.sapportals.wcm.repository.service.archiving.IArchivingService archivingService) |
| Modifier and Type | Class and Description |
|---|---|
class |
ReadOnlyModeException |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AddToFavoritesCommand.executeResourceImpl() |
IDiscussionManager |
DiscussionCommand.getDiscussionService()
First we suppose that res is a primary resource.
|
protected String |
ResourceCommand.getDuplicateName(RID rid) |
boolean |
LockResourceCommand.isResourceLocked() |
boolean |
LockResourceCommand.isResourceLockedByMe() |
boolean |
ResourceCommand.isResourceLockedByOther() |
boolean |
LockResourceCommand.isResourceReleased() |
| Modifier and Type | Method and Description |
|---|---|
void |
WcmResourceControl.setResource(IResource aResource)
Deprecated.
As of NetWeaver 7.1
|
| Modifier and Type | Method and Description |
|---|---|
void |
OrderedListEditorControl.addNewResource(String targetName,
String targetUri,
LinkType linkType)
Adds a new link to the link list
|
IPropertyMap |
PropertiesControlUtil.decodeProperties(String tokens,
Locale locale)
Creates a property map from a parsed string.
|
static IResource |
ResourceUtilities.dereferenceTarget(IResource resource)
dereferences to resource or external link, follows up the internal links
to get to original resource or external link finally,
prepare method to call getContent()
|
static ICollection |
ResourceUtilities.getCollection(String folderUri,
IResourceContext resourceContext,
boolean create)
gets ICollection object for a folder with given URI, shortcut method
|
static IProperty |
PropertiesControlUtil.getDefaultProperty(IMetaName metaName,
IMetaContext context) |
IPropertyConfigurationService |
ResourceCustomPropertyServiceControl.getService()
Get the Service attribute of the ResourceCustomPropertyServiceControl object.
|
static IResource |
ResourceUtilities.getTempResource(ICollection where,
String resourceName,
IContent content)
creates a temporary resource with content in collection specifed.
|
void |
ResourceEditControl.onAppletDownload(com.sapportals.htmlb.event.Event event) |
void |
ResourceEditControl.onAppletUpload(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceTextEditorIDResolverControl.onCancel(com.sapportals.htmlb.event.Event event)
Description of the Method
|
com.sapportals.wdf.event.WdfEvent |
ResourceTextEditorControl.onCancel(com.sapportals.htmlb.event.Event event)
Description of the Method
|
com.sapportals.wdf.event.WdfEvent |
ResourcePropertiesControl.onCancel(com.sapportals.htmlb.event.Event event)
Description of the Method
|
com.sapportals.wdf.event.WdfEvent |
ResourceNewCollectionControl.onCancel(com.sapportals.htmlb.event.Event event)
Description of the Method
|
com.sapportals.wdf.event.WdfEvent |
ResourceHtmlEditorControl.onCancel(com.sapportals.htmlb.event.Event event)
Description of the Method
|
com.sapportals.wdf.event.WdfEvent |
ResourceHtmlEditControl.onCancel(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceExtendedEditorControl.onCancel(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceEditControl.onCancel(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
PropertiesControl.onCancel(com.sapportals.htmlb.event.Event event)
Description of the Method
|
com.sapportals.wdf.event.WdfEvent |
ImageSelectControl.onCancel(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
CreateCollectionControl.onCancel(com.sapportals.htmlb.event.Event event)
Description of the Method
|
com.sapportals.wdf.event.WdfEvent |
CollectionOrderControl.onCancel(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceEditControl.onClientSideEdit(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceEditOnlineDescisionControl.onHtmlEditor(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceDeleteControl.onNo(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ImageSelectControl.onSave(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceEditOnlineDescisionControl.onTextEditor(com.sapportals.htmlb.event.Event event) |
| Modifier and Type | Method and Description |
|---|---|
IResourceList |
TreeCollectionInfoSample.getChildren(IResource resource) |
IResourceList |
ICollectionInfo.getChildren(IResource resource) |
IResourceList |
TreeCollectionInfoSample.getChildren(IResource resource,
boolean visible,
boolean collections,
boolean links) |
IResourceList |
ICollectionInfo.getChildren(IResource resource,
boolean visible,
boolean collections,
boolean links) |
int |
TreeCollectionInfoSample.getChildrenCount(IResource resource,
boolean visible,
boolean collections,
boolean links) |
int |
ICollectionInfo.getChildrenCount(IResource resource,
boolean visible,
boolean collections,
boolean links) |
boolean |
ResourceVersioningControl.getEnhancedFlag()
Gets the enhancedFlag attribute of the ResourceVersioningControl object
|
boolean |
ResourceSetStatemanagementControl.getEnhancedFlag()
Gets the enhancedFlag attribute of the ResourceSetStatemanagementControl object
|
boolean |
ResourceListControlOptions.getEnhancedFlag() |
IResourceList |
ResourceListControl.getSelectedResources() |
boolean |
ResourcePreviewControl.getShowResourceTile()
Gets the showResourceTile attribute of the ResourcePreviewControl
|
boolean |
ResourceTimeBasedPublishingControl.getTbpEnabledFlag()
Gets the tbpEnabledFlag attribute of the ResourceTimeBasedPublishingControl object
|
boolean |
ResourceListControlOptions.getTimebasePublishEnabledFlag() |
boolean |
TreeCollectionInfoSample.hasChildren(IResource resource) |
boolean |
ICollectionInfo.hasChildren(IResource resource) |
boolean |
TreeCollectionInfoSample.isAncestorOf(IResource parent,
IResource child) |
boolean |
ICollectionInfo.isAncestorOf(IResource parent,
IResource child) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onNewFile(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onNewFolder(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onNewLink(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onNewText(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onOthEvent(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
TaxonomyControl.onPage(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onPageFlip(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onSortSelect(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onStyle(com.sapportals.htmlb.event.Event event) |
com.sapportals.wdf.event.WdfEvent |
ResourceListControl.onToggleSort(com.sapportals.htmlb.event.Event event) |
void |
ResourceDetailsHeaderControl.setResource(IResource aResource) |
| Modifier and Type | Method and Description |
|---|---|
static HashMap |
PageControl.createToolTipTable(IResourceList resourceList,
int maxRows,
IPropertyName sortProperty)
Deprecated.
As of NetWeaver 7.1
|
static HashMap |
PageControl.createToolTipTable(String[] toolTips,
int maxRows)
Deprecated.
As of NetWeaver 7.1
|
static String |
PropertyRenderUtil.getDisplayName(IResource resource)
Deprecated.
return displayName for given resource
|
boolean |
FolderSettings.getOrderedFlag()
returns the ordered flag: Foldercontent is ordered manualy
|
static IPropertyName |
FolderSettings.getPropertyNameForColumn(String impColumn) |
Boolean |
FolderSettings.isEnhanced()
returns the enhanced Flag(meaning folder is versioned)
|
boolean |
FolderSettings.isEnhancedIsReadonly()
checks wheter the enhancedFlag is readonly
|
Boolean |
FolderSettings.isTimebasePublishEnabled()
returns the timebased publish enabled flag: returns null, if no timebasedpublish service is available
|
Integer |
FolderSettings.isTimebasePublishNotificationEnabled()
returns the timebased publish notification days: returns null, if no timebasedpublish service is available or notification is disabled
|
boolean |
FolderSettings.setEnhancedFlag(boolean i_enhanced)
Sets the enhanced Flag;
returns false, if the enhancedflag is readonly
|
| Modifier and Type | Method and Description |
|---|---|
static Document |
DOMResourceHelper.read(IResource resource)
Reads the specified XML resource into a DOM representation.
|
static Document |
DOMResourceHelper.read(String uri,
IResourceContext context)
Reads the specified XML resource into a DOM representation.
|
static void |
DOMResourceHelper.write(IResource resource,
Document document)
Writes the specified DOM representation to the specified XML resource.
|
static void |
DOMResourceHelper.write(IResource resource,
IDOMStorable storable)
Writes the specified DOM representation to the specified XML resource.
|
static void |
DOMResourceHelper.write(String uri,
Document document,
IResourceContext context)
Writes the specified DOM representation to the specified XML resource.
|
static void |
DOMResourceHelper.write(String uri,
IDOMStorable storable,
IResourceContext context)
Writes the specified DOM representation to the specified XML resource.
|
| Modifier and Type | Method and Description |
|---|---|
static ResourceException |
WDHttp.exception(RID rid,
int httpCode,
Name condition,
String message) |
static ResourceException |
WDHttp.exception(RID rid,
int httpCode,
String message)
Construct a resource exception for the given HTTP response
code and message.
|
static ResourceException |
WDHttp.exception(RID rid,
IResponse response)
Construct a resource exception for the given HTTP response
code and message.
|
static ResourceException |
WDHttp.exception(UriContext uc,
IResponse response,
String message)
Construct a resource exception for the give HTTP response
code and message.
|
static ResourceException |
WDHttp.exception(UriContext uc,
IResponse response,
String message,
RID target)
Construct a resource exception for the give HTTP response
code and message.
|
static ResourceException |
WDHttp.getError(IResponse response,
UriContext uc,
String message,
RID target) |
| Modifier and Type | Method and Description |
|---|---|
IUriReference |
AccessURIGenerator.getAccessUri(IResource resource,
String action) |
IUriReference |
AccessURIGenerator.getAccessUri(IResource resource,
String action,
String zipFileName)
Constructs a URI reference to initiate a special action inside the WDGetHandler,
such as the download of a resource.
|
IContent |
NewsFeedProvider.getContentForResource(IResource res,
IHierarchicalUri baseUri) |
IContent |
DavMountProvider.getContentForResource(IResource res,
IHierarchicalUri baseUri) |
| Modifier and Type | Method and Description |
|---|---|
ICfgResource |
ConfigRepository.create(RID rid,
IContent content,
boolean replaceExisting) |
ICfgResource |
ConfigRepository.create(RID rid,
IPropertyMap props,
boolean replaceExisting) |
ICfgResource |
ConfigRepository.create(RID rid,
Map props,
boolean replaceExisting) |
void |
ConfigRepository.delete(RID rid) |
IContent |
ICfgResource.getContent() |
static ConfigRepository |
ConfigRepository.getInstance(IResourceContext context) |
List |
ICfgCollection.getMemberRIDs() |
IPropertyMap |
ICfgResource.getProperties() |
ICfgResource |
ConfigRepository.getResource(RID rid) |
static boolean |
ConfigRepository.handles(RID rid) |
ICfgResource |
ConfigRepository.update(RID rid,
IPropertyMap props) |
ICfgResource |
ConfigRepository.update(RID rid,
Map props) |
| Modifier and Type | Method and Description |
|---|---|
HttpRequest |
IHTMLLogin.createRequest(UserInfo ui)
Create a http request object suitable for sending the login form data
|
HttpRequest |
HTMLLogin.createRequest(UserInfo ui) |
| Modifier and Type | Method and Description |
|---|---|
static void |
WDProperties.appendProperty(Element parent,
IPropertyName pname,
IProperty prop,
DateFormat df,
IHierarchicalUri baseUri) |
static void |
WDProperties.appendProperty(Element parent,
IPropertyName pname,
IProperty prop,
DateFormat df,
IHierarchicalUri baseUri,
boolean includeHiddenFlag)
Add a Property definition as child of an element.
|
static void |
WDProperties.appendPropertyValue(Element parent,
IProperty prop,
DateFormat df,
boolean includeHiddenFlag) |
static void |
WDProperties.appendPropertyValue(Element parent,
IProperty prop,
DateFormat df,
IHierarchicalUri baseUri,
boolean includeHiddenFlag)
Add a Property Value as child of an element.
|
IBindableResource |
WDResourceInfo.asBindableResource() |
ICollectionVersionResource |
WDResourceInfo.asCollectionVersionResource() |
IPrincipal |
WDResourceInfo.asPrincipal() |
IVersionControlledResource |
WDResourceInfo.asVersionControlledResource() |
IVersionHistoryResource |
WDResourceInfo.asVersionHistoryResource() |
IVersionResource |
WDResourceInfo.asVersionResource() |
WDAcl |
WDResourceInfo.getAcl() |
IContent |
WDResourceInfo.getContent(boolean unfiltered)
Returns the content access object for this resource.
|
Date |
WDResourceInfo.getCreationDate()
Get value of the system property CreationDate
|
Set |
WDResourceInfo.getCurrentUserPrivileges() |
String |
WDResourceInfo.getDescription()
Get value of the system property Description
|
String |
WDResourceInfo.getDisplayName()
Get value of the system property Displayname
|
static ServerRequestBroker |
ServerRequestBroker.getInstance(IHierarchicalUri base,
Properties config,
IServerInfo server)
Get a ServerRequestBroker for use against the server, given configuration properties
and base uri.
|
static ServerRequestBroker |
ServerRequestBroker.getInstance(IHierarchicalUri base,
ServerRequestBroker template) |
Date |
WDResourceInfo.getLastModified()
Get value of the system property LastModified
|
LinkType |
WDResourceInfo.getLinkType() |
String |
WDResourceInfo.getName()
Get name of the resource.
|
IUri |
WDResourceInfo.getOrderingType() |
RID |
WDResourceInfo.getOwner() |
String |
WDResourceInfo.getOwnerDisplayname() |
IPropertyMap |
WDResourceInfo.getProperties()
Returns a map with
IProperty references for the resource. |
IProperty |
WDResourceInfo.getProperty(IPropertyName pname) |
static IMutableProperty |
WDProperties.getProperty(IPropertyName pname,
Element e,
DateFormat df,
IHierarchicalUri baseUri,
boolean tolerateTypeError)
Create a Property from its XML/WebDAV serialization.
|
static IMutableProperty |
WDProperties.getProperty(IPropertyName pname,
PropertyType pt,
Element e,
DateFormat df)
Create a Property from its XML/WebDAV serialization.
|
IRequester |
ServerRequestBroker.getRequester(IResourceContext context)
Get a IWDRequester suitable for this server and the given resource
context.
|
RID |
WDResourceInfo.getRID()
Get the RID of this resource
|
IPrivilege |
WDResourceInfo.getSupportedPrivileges() |
String |
WDResourceInfo.getTargetURL()
Get the target URL/URI of a link.
|
IResourceList |
WDResourceInfo.getVersionResources()
Get the version history for the resource.
|
boolean |
WDResourceInfo.hasAclSupport() |
void |
WDResourceInfo.initProperties()
Initializes the set of properties to be used with this
WDResourceInfo object. |
boolean |
WDResourceInfo.isCheckedOut()
Checks whether a resource is currently checked out.
|
boolean |
WDResourceInfo.isHidden()
Get value of the system property Hidden
|
boolean |
WDResourceInfo.isLinkToCollection() |
boolean |
WDResourceInfo.isPrincipal() |
boolean |
WDResourceInfo.isReadOnly()
Get value of the system property Readonly
|
boolean |
WDResourceInfo.isVersioned()
Returns true if the resource supports versioning.
|
boolean |
WDResourceInfo.isVhr() |
static void |
WDProperties.setElementAttributes(Element elem,
IProperty property) |
void |
ServerRequestBroker.shutdown() |
| Constructor and Description |
|---|
WDPropertyDef(Name name) |
WDPropertyDef(Name name,
IPropertyName internal,
boolean isProtected,
boolean isHidden) |
WDPropertyDef(Name name,
IPropertyName internalName,
PropertyType type,
boolean isProtected,
boolean isHidden) |
| Modifier and Type | Class and Description |
|---|---|
class |
AclPreconditionException
Information about a failed ACL precondition.
|
class |
MissingDavPrivilegeException
Exception used to indicate the missing DAV privilege DAV:write-acl
Copyright (c) SAP AG 2002
|
| Modifier and Type | Method and Description |
|---|---|
protected static ResourceException |
WDAcl.map(AclException ex,
RID rid) |
| Modifier and Type | Method and Description |
|---|---|
void |
WDAcl.appendTo(Element element,
IHierarchicalUri servletUri)
Append a WebDAV ACL conform representation of the Access Control
List to the given Element.
|
IPrivilege |
WDPrivilegeTree.find(RID rid,
IAclPermission permission) |
IPrivilege |
WDPrivilegeTree.find(RID rid,
Name name) |
List |
WDAcl.getAces()
Return the List of
IAce
objects for this Access Control List |
List |
WDAcl.getAces(Element acl,
IHierarchicalUri baseUrl,
IResourceContext context)
Return the List of
IAce
objects, representing the given DAV:ace property |
Set |
WDAcl.getCurrentUserSet()
Retrieves the DAV:current-user-privilege-set as Set of
IPrivileges. |
static WDPrivilege |
WDPrivilege.getInstance(IAclPermission permission) |
protected static com.sapportals.wcm.protocol.webdav.repository.acl.IPrivilegeTree |
WDPrivilegeTree.getInstance(IResourceAclManager aclmgr,
IResource resource) |
IPrincipal |
WDAcl.getOwner()
Return the principal owning the ACL.
|
IPrivilege |
WDAcl.getSupported()
Retrieve the tree's root of supported IPrivileges.
|
Set |
WDPrivilegeTree.mapPermissions(RID rid,
List permissions,
boolean canWriteAcl) |
void |
WDAcl.setAces(List newList,
boolean deep)
Sets the list of given IAce objects as new access control list.
|
Element |
WDAcl.toElement(Document document,
IHierarchicalUri servletUri)
Return an Element representing the DAV:acl property for the
access control list of the resource.
|
| Constructor and Description |
|---|
WDAcl(IResource resource)
Construct a WDAcl for a certain resource.
|
| Modifier and Type | Method and Description |
|---|---|
static ITimeGuard |
TimeGuard.install(String operation,
IResource resource)
Install a new
ITimeGuard in the given context |
| Modifier and Type | Method and Description |
|---|---|
List |
IPrincipalSearchArbiter.getSearchableProperties()
Get list of searchable properties for this resource and it's descendants.
|
IRidSet |
IPrincipalSearchArbiter.search(IRidSet scope,
Map criteria)
Search for principals satisfying a set of criteria.
|
IRidSet |
IPrincipalSearchArbiter.search(RID scope,
Map criteria)
Variant of
IPrincipalSearchArbiter.search(IRidSet, Map) with a single resource scope. |
| Modifier and Type | Method and Description |
|---|---|
void |
ResourceInitializer.copy(RID targetCollection,
boolean createTarget,
ClassResource[] resources) |
static ResourceInitializer |
ResourceInitializer.getInstance(IResourceContext context) |
ICollection |
ResourceInitializer.mkcol(RID rid) |
ICollection |
ResourceInitializer.mkcol(RID rid,
IProperty[] props) |
| Modifier and Type | Method and Description |
|---|---|
protected IResource |
AbstractUICommand.createResource(String uri)
Deprecated.
As of NetWeaver 7.1
|
protected IResource |
AbstractCommand.createResource(String uri)
Deprecated.
As of NetWeaver 7.1
|
protected IResource |
AbstractUICommand.resolveLink()
Deprecated.
As of NetWeaver 7.1
|
protected IResource |
AbstractCommand.resolveLink()
Deprecated.
As of NetWeaver 7.1
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractPropertyException
Abstract base class for property exceptions.
|
class |
AccessDeniedException
Access to a resource or property is denied because the user does not have the
required authorization.
|
class |
AuthorizationRequiredException
The user is not authorized.
|
class |
CheckedOutException
The resource is checked out by another user.
|
class |
DestinationNotSupportedException
The repository manager does not support the operation for the given destination.
|
class |
ExpectedCheckInRIDException
The RID of the new revision is different from the RID that the application
expected when checking out.
|
class |
ExpectedCheckInURIException
Deprecated.
as of NW04.
|
class |
ExtensionDeniedException |
class |
ExternalLinkException
The requested RID contains an external link.
|
class |
IllegalPropertyNameException
Raised when a property name was not acceptable.
|
class |
IncompleteOperationException
An operation did not complete because of precondition failures.
|
class |
InternalLinkException
The requested RID contains an internal link to a collection.
|
class |
InvalidArgumentException
One ore more invalid values where provided for the parameters of a method.
|
class |
InvalidCharacterException |
class |
InvalidNameException
The application tried to use a invalid resource name
|
class |
InvalidPositionException
The required positioning was not valid (usually because the referenced
collection member did not exist).
|
class |
InvalidTargetException
An invalid target was used for a copy or move operation.
|
class |
InvalidUriException
An invalid URI was used.
|
class |
IOErrorException
An IO error occured while trying to access a resource.
|
class |
LabelAlreadyExistsException
The application tried to add a label that already exists in the version history.
|
class |
LabelNotFoundException
The application tried to remove a label that did not exist in the version history.
|
class |
LinkLoopException
The target RID specified when creating or updating am internal link is also a
link and would cause an loop.
|
class |
LockedException
The resource was locked by another user.
|
class |
LockNotFoundException
The requested lock does not exist.
|
class |
MethodNotAllowedException
The resource does not support the operation
|
class |
NameAlreadyExistsException
The application tried to use a name for a new resource that already exists in
the collection.
|
class |
NoContentException
The resource has no content
|
class |
NoExtensionDeniedException |
class |
NoRevisionException
The resource is not a revision resource.
|
class |
NotCheckedOutException
The resource is not checked out
|
class |
NotOrderedException
An attempt was made to perform an ordering operation on an unordered
collection.
|
class |
NotSupportedException
The repository manager does not support the operation.
|
class |
NotVersionedException
The application tried a versioning-related operation on a resource that is not version-controlled.
|
class |
PropertyMandatoryException
The property could not be removed because it is mandatory.
|
class |
PropertyNameTooLongException
Raised when a property name was too long.
|
class |
PropertyReadOnlyException
The property cannot be changed because it is read-only.
|
class |
PropertyTypeLostException
Raised when a property was set, but the repository didn't support the desired
type.
|
class |
PropertyTypeMismatchException
Raised when an attempt was made to set a protected property with a
non-applicable data type.
|
class |
PropertyUnchangedException
Raised when a property change couldn't be commited due to a failed dependency
on another change.
|
class |
PropertyValueTooBigException
Raised when a property value was too big.
|
class |
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. |
class |
ResourceNotCollectionException
Indicates that the resource has changed to a non-collection since the
IResource object was obtained.
|
class |
ResourceNotFoundException
Indicates that a resource could not be found.
|
class |
ResourceReadOnlyException
The resource is read-only.
|
class |
RevisionResourceException
The operation is not available because the resource is a revision.
|
class |
ServiceUnavailableException
A service is not available.
|
class |
SetPropertiesException
This exception indicates errors during a
IResource.setProperties(List)
call. |
class |
TimeExceededException
Indicates that the time for an operation has exceeded its set limit.
|
class |
TuccConstraintException |
class |
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).
|
class |
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.
|
class |
VersionHistoryInUseException
Thrown if someone tries to create a VCR in a workspace that
already contains a VCR with the same version history.
|
class |
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.
|
class |
VirusContentException
This exception is raised when a check reveals that content being read/written possibly contains a Virus.
|
| Modifier and Type | Method and Description |
|---|---|
ResourceException |
ICopyParameter.getFirstResourceException()
Get the first resource exception.
|
ResourceException |
CopyParameter.getFirstResourceException() |
ResourceException |
ResourceException.getNextResourceException()
Returns the next ResourceException or
null |
ResourceException |
ResourceErrors.getResourceException()
Returns the first exception.
|
ResourceException |
PropertyChangeResult.getResourceException()
Returns the exception that occured in the property manager when setting the
property.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ResourceErrors.append(ResourceException ex)
Appends the exception to the list
|
void |
ResourceException.setNextResourceException(ResourceException nextEx)
Sets a reference to the next ResourceException
|
| Modifier and Type | Method and Description |
|---|---|
void |
IVersionResource.addLabel(String labelName)
Adds the given label if and only if it didn't exist before in the version's
version history.
|
void |
MutableProperty.addValue(Object value) |
void |
MutableMultiLanguagedProperty.addValue(Object value) |
void |
IMutableProperty.addValue(Object value)
Adds a value to the list for a multi-value property
|
Object |
IResource.as(Class classref)
Get a representation of this resource as the specified class.
|
boolean |
Selector.check(IPropertyMap properties)
checks, if the provided map of properties will pass all
PropertySelectorItem
instances defined within this class. |
boolean |
IResourceFactory.checkExistence(RID rid,
IResourceContext context)
Returns
true if a resource exists for the given resource identifier. |
boolean |
IResourceFactory.checkExistence(URI uri,
IResourceContext context)
Deprecated.
As of EP 5.0 SP3, replaced by method with RID parameter.
|
ICheckInInfo |
IResource.checkIn(IContent newContent,
IPropertyMap properties)
Check in a new version of the resource with new content and/or properties.
|
ICheckInInfo |
IResource.checkIn(IContent newContent,
IPropertyMap properties,
boolean ignorePropertyFailures)
Check in a new version of the resource with new content and/or properties.
|
ICheckInInfo |
IResource.checkIn(IContent newContent,
IPropertyMap properties,
boolean ignorePropertyFailures,
RID expectedCheckInRID)
Check in a new version of the resource with new content and/or properties.
|
ICheckInInfo2 |
IVersionControlledResource.checkIn(IContent newContent,
IPropertyMap properties,
boolean ignorePropertyFailures,
RID expectedCheckInRID,
boolean forkOk,
boolean keepCheckedOut)
Check in a new version of the resource with new content and/or properties.
|
ICheckInInfo |
IResource.checkIn(IContent newContent,
IPropertyMap properties,
boolean ignorePropertyFailures,
URI expectedCheckInURI)
Deprecated.
As of EP 5.0 SP4
|
ICheckOutInfo |
IResource.checkOut()
Check out the resource for editing.
|
ICheckOutInfo2 |
IVersionResource.checkOut(boolean forkOk)
Checkout the version.
|
ICheckOutInfo2 |
IVersionControlledResource.checkOut(boolean applyToVersion,
boolean forkOk)
Checkout the version controlled resource or it's checked-in version.
|
IResource |
IResource.copy(RID destinationRID,
ICopyParameter param)
Copy the resource.
|
IResource |
IResource.copy(RID destinationRID,
IPosition position,
ICopyParameter param)
Copy the resource to a destination collection that supports ordered
children.
|
IResource |
IResource.copy(URI destinationURI,
ICopyParameter param)
Deprecated.
As of EP 5.0 SP5, replaced by copy() with RID parameter.
|
IResource |
IResource.copy(URI destinationURI,
IPosition position,
ICopyParameter param)
Deprecated.
As of EP 5.0 SP5, replaced by copy() with RID parameter.
|
boolean |
IBindController.createBind(String memberName,
IPosition position,
IResource targetResource,
boolean overwrite)
Adds a new member name to the collection referencing the identified
resource.
|
boolean |
IBindController.createBind(String memberName,
IPosition position,
RID targetRid,
boolean overwrite)
Adds a new member name to the collection referencing the identified
resource.
|
ICollection |
ICollection.createCollection(String name,
IPosition position,
IPropertyMap properties)
Creates a new sub collection in a collection that supports ordering.
|
ICollection |
ICollection.createCollection(String name,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new sub collection in a collection that supports ordering.
|
ICollection |
ICollection.createCollection(String name,
IPropertyMap properties)
Creates a new sub collection in a collection.
|
ICollection |
ICollection.createCollection(String name,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new sub collection in a collection.
|
static IProperty |
Property.createContentLanguageProp(String value) |
static IProperty |
Property.createContentLengthProp(long length) |
static IProperty |
Property.createContentTypeProp(String value) |
static IProperty |
Property.createCreatedByProp(String value) |
static IProperty |
Property.createCreationDateProp(Date date) |
static IProperty |
Property.createDescriptionProp(String value) |
static IProperty |
Property.createDisplaynameProp(String value) |
static IProperty |
Property.createETagProp(String value) |
IResource |
IExtendedCollection.createExternalLink(String name,
IUri target,
boolean isPermanent,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
|
IResource |
IExtendedCollection.createExternalLink(String name,
IUriReference target,
boolean isPermanent,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates an external link, compatible to
LinkType.EXTERNAL |
static IProperty |
Property.createHiddenProp(boolean value) |
IResource |
IExtendedCollection.createInternalDynamicLink(String name,
RID targetRid,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates an internal link that automatically follows the target resource and
disappears when the link target disappears.
|
IResource |
IExtendedCollection.createInternalStaticLink(String name,
RID targetRid,
boolean isPermanent,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates an internal link, compatible to
LinkType.INTERNAL |
static IProperty |
Property.createLastModifiedByProp(String value) |
static IProperty |
Property.createLastModifiedProp(Date date) |
static IResource |
CollectionInterpreter.createLink(ICollection collection,
String name,
URL targetURL,
LinkType linkType,
IPosition position,
IPropertyMap properties)
Method with new enum signatures resembling method
ICollection.createLink(String, URL, com.sapportals.wcm.repository.enums.LinkType, IPosition, IPropertyMap) |
static IResource |
CollectionInterpreter.createLink(ICollection collection,
String name,
URL targetURL,
LinkType linkType,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
Method with new enum signatures resembling method
ICollection.createLink(String, URL, com.sapportals.wcm.repository.enums.LinkType, IPosition, IPropertyMap, boolean) |
static IResource |
CollectionInterpreter.createLink(ICollection collection,
String name,
URL targetURL,
LinkType linkType,
IPropertyMap properties)
Method with new enum signatures resembling method
ICollection.createLink(String, URL, com.sapportals.wcm.repository.enums.LinkType, IPropertyMap) |
static IResource |
CollectionInterpreter.createLink(ICollection collection,
String name,
URL targetURL,
LinkType linkType,
IPropertyMap properties,
boolean ignorePropertyFailures)
Method with new enum signatures resembling method
ICollection.createLink(String, URL, com.sapportals.wcm.repository.enums.LinkType, IPropertyMap, boolean) |
IResource |
ICollection.createLink(String name,
URL targetURL,
LinkType linkType,
IPosition position,
IPropertyMap properties)
Creates a new link in a collection that supports ordering.
|
IResource |
ICollection.createLink(String name,
URL targetURL,
LinkType linkType,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new link in a collection that supports ordering.
|
IResource |
ICollection.createLink(String name,
URL targetURL,
LinkType linkType,
IPropertyMap properties)
Creates a new link in a collection.
|
IResource |
ICollection.createLink(String name,
URL targetURL,
LinkType linkType,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new link in a collection.
|
static IProperty |
PropertyInterpreter.createPropertyFromStringValue(IPropertyName name,
PropertyType type,
String svalue) |
static IProperty |
Property.createPropertyFromStringValue(IPropertyName name,
PropertyType type,
String svalue) |
static IProperty |
Property.createReadOnlyProp(boolean value) |
ILockInfo |
ICollection.createResource(String name,
ILockProperties lockProperties)
Creates a empty resource that is initially locked (lock null resource)
|
IResource |
ICollection.createResource(String name,
IPosition position,
IPropertyMap properties,
IContent content)
Creates a new resource in a collection that supports ordering.
|
IResource |
ICollection.createResource(String name,
IPosition position,
IPropertyMap properties,
IContent content,
boolean ignorePropertyFailures)
Creates a new resource in a collection that supports ordering.
|
IResource |
ICollection.createResource(String name,
IPropertyMap properties,
IContent content)
Creates a new resource in a collection.
|
IResource |
ICollection.createResource(String name,
IPropertyMap properties,
IContent content,
boolean ignorePropertyFailures)
Creates a new resource in a collection.
|
static IProperty |
Property.createResourceTypeProp(String value) |
IResource |
IExtendedCollection.createVersionControlledResource(RID baseRevisionRid,
String name,
IPosition position)
If called on a workspace controlled collection, a new version controlled
resource based on the given revision is created
|
ICollection |
IExtendedCollection.createWorkspace(String name,
IPosition position)
Creates a new workspace resource.
|
void |
IResource.delete()
Deletes this resource from the repository.
|
void |
IArchivingFactory.delete(RID resourceID,
IResourceContext context)
Deletes an expired resource from the backend.
|
void |
IResource.deleteProperty(IPropertyName propName)
Removes the property.
|
void |
MutableMultiLanguagedProperty.deleteValue(String languageTag) |
void |
IMutableMultiLanguagedProperty.deleteValue(String languageTag)
Removes a language specific value of this property
|
void |
IVersionController.disable(boolean disableChildVersioning)
Disables child version controlling for this collection.
|
void |
IVersionController.enable(IResourceList modifiedResources)
Enables child version controlling for this collection -- if a new
non-collection child is created it will be put under version control
immediately and automatically.
|
void |
IResource.enableVersioning(boolean enable)
Enables or disables versioning.
|
RID |
IResource.getAccessRID()
Returns the RID that was used to create this resource object in the
IResourceFactory method call. |
URI |
IResource.getAccessURI()
Deprecated.
As of EP 5.0 SP3, replaced by
IResource.getAccessRID() |
IArchivingFactory |
IResourceFactory.getArchivingFactory()
Returns an instance of the archiving factory.
|
String |
Property.getAttribute(String name) |
String |
MutableMultiLanguagedProperty.getAttribute(String name) |
String |
IProperty.getAttribute(String name)
Get the value of an attribute
|
Properties |
Property.getAttributes() |
Properties |
MutableMultiLanguagedProperty.getAttributes() |
Properties |
IProperty.getAttributes()
Returns a collection of attributes
|
RID |
IWorkingResource.getAutoUpdateVCR() |
IName |
IVersionControlledResource.getAutoVersioningMode() |
IRidSet |
IBindableResource.getBindings() |
boolean |
MutableMultiLanguagedProperty.getBooleanValue(String languageTag) |
boolean |
IMultiLanguagedProperty.getBooleanValue(String languageTag)
Get the property value if the type is PropertyType.BOOLEAN for the desired languageTag
|
IResource |
IVersionControlledResource.getCheckedInResource() |
RID |
IVersionControlledResource.getCheckedInRID() |
IResource |
IVersionControlledResource.getCheckedOutResource() |
IResourceList |
IVersionResource.getCheckedOutResources() |
IResourceList |
IResource.getCheckedOutResources()
Returns a list of currently checked out resources.
|
RID |
IVersionControlledResource.getCheckedOutRID() |
IRidSet |
IVersionResource.getCheckedOutRIDs() |
Set |
IVersionResource.getCheckInForkBehaviour() |
Set |
IVersionControlledResource.getCheckInForkBehaviour() |
Set |
IVersionResource.getCheckOutForkBehaviour() |
Set |
IVersionControlledResource.getCheckOutForkBehaviour() |
ICheckOutInfo |
ICheckInInfo2.getCheckOutInfo() |
IRidSet |
IWorkspaceResource.getCheckOutSet()
Returns a set containing all checked-out resources that belong to the
workspace identified by this resource.
|
IResourceList |
ICollection.getChildren()
Returns a list of all resources in the collection
|
IResourceList |
ICollection.getChildren(boolean visible,
boolean collections,
boolean links)
Returns a filtered list of the resources in this collection.
|
IResourceList |
IExtendedCollection.getChildren(Boolean visible,
Boolean collections,
Boolean links)
Returns a filtered list of the resources in this collection.
|
IResourceList |
ICollection.getChildren(Selector childrenSelector,
Collator sortBy,
IPropertyNameList propertyPrefill)
Returns the children of this collection.
|
IResourceList |
ICollection.getChildren(Selector childrenSelector,
Collator sortBy,
IPropertyNameList propertyPrefill,
String[] permissionNames)
Returns the children of this collection.
|
int |
ICollection.getChildrenCount(boolean visible,
boolean collections,
boolean links)
Returns the number of filtered children in the collection.
|
IResourceList |
ICollection.getChildrenWithoutLinkMapping()
This method will return all child resources without performing the special handling for link resources.
|
IContent |
IResource.getContent()
Returns the content of this resource.
|
IContent |
IResource.getContent(boolean handleExternalLink)
Deprecated.
As of EP 5.0 SP 5
This method is deprecated because it opens a potential security hole: The URL of an external link can have different schemas (e.g. "file:") which are all accessed with the security context of the servlet engine. This could be (ab)used to access files/resources on the local server and other systems without the security context of the logged in user.
No longer supported as of SP6: Throws a NotSupportedException if
parameter is |
Date |
MutableMultiLanguagedProperty.getDateValue(String languageTag) |
Date |
IMultiLanguagedProperty.getDateValue(String languageTag)
Get the property value if the type is PropertyType.DATE for the desired languageTag
|
String |
MutableMultiLanguagedProperty.getDefaultLanguage() |
Set |
IVersionControlledResource.getEclipsedSet()
(version controlled collection only)
|
String |
IEntityMetadata.getEntityTag()
|
String |
Content.getEntityTag() |
IRidList |
IArchivingFactory.getExpiredResources(RID managerID,
IResourceContext context)
Returns a list with resources that have expired retention period.
|
Date |
IEntityMetadata.getExpiryDate() |
Date |
Content.getExpiryDate() |
IFilterFactory |
IResourceFactory.getFilterFactory()
Returns a instance of the FilterFactory
|
IUri |
IBindableResource.getGloballyUniqueId() |
IProperty |
IResource.getInheritedProperty(IPropertyName propName)
Get a property of the resource or inherit it.
|
static IResourceFactory |
ResourceFactory.getInstance()
Returns a reference to the resource factory instance.
|
int |
MutableMultiLanguagedProperty.getIntValue(String languageTag) |
int |
IMultiLanguagedProperty.getIntValue(String languageTag)
Get the property value if the type is PropertyType.INTEGER for the desired languageTag
|
Set |
IVersionResource.getLabelSet() |
String |
IEntityMetadata.getLanguage() |
String |
Content.getLanguage() |
String[] |
MutableMultiLanguagedProperty.getLanguageTags() |
String[] |
IMultiLanguagedProperty.getLanguageTags() |
String[] |
MutableMultiLanguagedProperty.getLanguageTagsNeedingTranslation() |
String[] |
IMultiLanguagedProperty.getLanguageTagsNeedingTranslation() |
Date |
IEntityMetadata.getLastModified() |
Date |
Content.getLastModified() |
String |
MutableMultiLanguagedProperty.getLastSetLanguageTag() |
String |
IMultiLanguagedProperty.getLastSetLanguageTag() |
LinkType |
IResource.getLinkType()
Returns the link type (NONE if the resource is not a link).
|
LinkType |
ILink.getLinkType()
Returns the link type
|
static LinkType |
ResourceInterpreter.getLinkType(IResource instance)
Method with new enum signatures resembling method
IResource.getLinkType() |
ILockInfo |
IResource.getLockByToken(String lockToken)
Get a LockInfo for the token.
|
ILockInfoCollection |
IResource.getLocks()
Returns a collection of all existing locks.
|
long |
MutableMultiLanguagedProperty.getLongIntValue(String languageTag) |
long |
IMultiLanguagedProperty.getLongIntValue(String languageTag)
Get the property value if the type is PropertyType.LONG for the desired languageTag
|
IManagerFactory |
IResourceFactory.getManagerFactory()
Returns a instance of the ManagerFactory
|
IMutableMultiLanguagedProperty |
IMultiLanguagedPropertyContainer.getMutableMultiLangProperty(IPropertyName name) |
String |
IResource.getName()
Get name of the resource.
|
Object |
IResourceFactory.getObject(RID rid,
IResourceContext context,
Class asClass)
Returns a resource object converted into a semantic object for the given resource identifier and context.
|
IUri |
IOrderableCollection.getOrderingType()
Returns information about the collection's ordering, where the following
URIs are reserved:
"DAV:unordered": unordered collection
"DAV:custom": client-maintained ordering, no additional information about the ordering semantics available Any other URI identifies an ordering for which additional information semantics MAY be available at the given URI |
IUri |
ICollectionVersionResource.getOrderingType()
Returns information about the collection version's ordering, where the
following URIs are reserved:
"DAV:unordered": unordered collection
"DAV:custom": client-maintained ordering, no additional information about the ordering semantics available Any other URI identifies an ordering for which additional information semantics MAY be available at the given URI |
OrderType |
ICollection.getOrderType()
Returns the order type of a collection
|
static OrderType |
CollectionInterpreter.getOrderType(ICollection instance) |
ICollection |
IResource.getParentCollection()
Returns the parent collection of this resource.
|
static PropertyName |
PropertyName.getPN(Name name)
Get a property name from a
Name instance. |
static PropertyName |
PropertyName.getPN(String namespace,
String name)
Get a property name instance for a given namespace and name.
|
IResourceList |
IVersionResource.getPredecessorResources() |
IResourceList |
IVersionControlledResource.getPredecessorResources() |
IRidSet |
IVersionResource.getPredecessorRIDs() |
IRidSet |
IVersionControlledResource.getPredecessorRIDs() |
IPropertyMap |
IResource.getProperties()
Returns a map with
IProperty references for the resource. |
IPropertyMap |
IResource.getProperties(IPropertyNameList propNameList)
Returns a map with
IProperty references for the resource. |
IProperty |
IResource.getProperty(IPropertyName propName)
Get a property.
|
IResource |
IResourceFactory.getResource(RID rid,
boolean resolveInternalLinks,
IResourceContext context)
Returns a resource object instance for the given RID and context.
|
IResource |
IResourceFactory.getResource(RID rid,
IResourceContext context)
Returns a resource object instance for the given resource identifier and context.
|
IResource |
IResourceFactory.getResource(RID rid,
IResourceContext context,
boolean createCollections)
Returns a resource object instance for the given RID and context.
|
IResource |
IResourceFactory.getResource(URI uri,
IResourceContext context)
Deprecated.
As of EP 5.0 SP3, replaced by getResource() method with RID parameter.
|
IResource |
IResourceFactory.getResource(URI uri,
IResourceContext context,
boolean createCollections)
Deprecated.
As of EP 5.0 SP3, replaced by getResource() method with RID parameter.
|
IResourceList |
IResourceFactory.getResources(IRidList ridList,
Map propertyMaps,
ResourceErrors errors,
IResourceContext context)
Returns a list of resource instances for a list of resource identifiers and possible
IPropertyMaps for the
resources. |
IResourceList |
IResourceFactory.getResources(IRidList ridList,
Map propertyMaps,
ResourceErrors errors,
String[] permissionNames,
IResourceContext context)
Returns a list of resource instances for a list of resource identifiers and possible
IPropertyMaps for the
resources. |
IResourceList |
IResourceFactory.getResources(IRidList ridList,
ResourceErrors errors,
IResourceContext context)
Returns a list of resource instances for an array of resource identifiers.
|
IResourceList |
IResourceFactory.getResources(IRidList ridList,
ResourceErrors errors,
String[] permissionNames,
IResourceContext context)
Returns a list of resource instances for an array of resource identifiers and removes resources without the
specified permission(s) from the result list.
|
IResourceList |
IResourceFactory.getResources(IUriList uriList,
ResourceErrors errors,
IResourceContext context)
Deprecated.
As of EP 5.0 SP3, replaced by getResources() method with IRidList parameter.
|
RID |
IResource.getRID()
Get the ID (path) of this resource.
|
IResource |
IVersionHistoryResource.getRootVersionResource() |
RID |
IVersionHistoryResource.getRootVersionRID() |
IResourceContext |
IResourceFactory.getServiceContext()
Returns a new resource context for services with an anonymous user
|
IResourceContext |
IResourceFactory.getServiceContext(String userID)
Deprecated.
As of NetWeaver 7.1, replaced by
IResourceFactory.getServiceContextUME(String) |
IResourceContext |
IResourceFactory.getServiceContextUME(String userName)
Returns a new resource context for services with an anonymous user
|
IRepositoryServiceFactory |
IResourceFactory.getServiceFactory()
Returns a instance of the ServiceFactory
|
IArchivingSession |
IArchivingFactory.getSession(RID managerID,
long expireDate,
IResourceContext context)
Gets an archiving session used to archive several resources belonging to one AO.
|
String |
MutableMultiLanguagedProperty.getStringValue(String languageTag) |
String |
IMultiLanguagedProperty.getStringValue(String languageTag)
Get the property value if the type is String for the desired languageTag
|
IResourceList |
IVersionResource.getSuccessorResources() |
IRidSet |
IVersionResource.getSuccessorRIDs() |
IEventList |
IResource.getSupportedEvents()
Returns a collection of supported resource events and semantic events for
this resource.
|
IResource |
IResource.getTargetResource()
Returns the target resource of an internal link.
|
IResource |
IInternalLinkResource.getTargetResource()
Gets the link target.
|
RID |
IInternalLinkResource.getTargetRID()
Gets the link target.
|
IUri |
IExternalLinkResource.getTargetUri()
Deprecated.
use
IExternalLinkResource.getTargetUriReference() instead |
IUriReference |
IExternalLinkResource.getTargetUriReference() |
URL |
IResource.getTargetURL()
Returns the target URL of a link or
null if the resource is
not a link. |
static LinkType |
LinkInterpreter.getType(ILink link)
Method with new enum signatures resembling method
ILink.getLinkType() |
IContent |
IResource.getUnfilteredContent()
Returns the content of this resource without applying content filters.
|
IContent |
IResource.getUnfilteredContent(boolean handleExternalLink)
Returns the content of this resource without applying content filters.
|
URI |
IResource.getURI()
Deprecated.
As of EP 5.0 SP3, replaced by
IResource.getRID() |
String |
ILink.getURL()
Returns the target URL
|
Object |
Property.getValue() |
Object |
MutableMultiLanguagedProperty.getValue() |
Object |
IProperty.getValue()
Returns the property value as a Object if this is not a multi-valued property.
|
String |
MutableMultiLanguagedProperty.getValueAsString(String languageTag) |
String |
IMultiLanguagedProperty.getValueAsString(String languageTag)
Get the property value converted to a string for the desired languageTag.
|
List |
Property.getValues() |
List |
MutableMultiLanguagedProperty.getValues() |
List |
IProperty.getValues()
Returns the property values if this is a multi-valued property.
|
Map |
ICollectionVersionResource.getVersionControlledBindingSet() |
IRidSet |
IVersionHistoryResource.getVersionControlledResourceRIDs() |
IRidSet |
IVersionHistoryResource.getVersionControlledResourceRIDs(RID scope) |
IVersionHistory |
IResource.getVersionHistory()
Returns the version history of this resource.
|
IRidSet |
IResourceMetadata.getVersionHistoryCollectionSet()
Returns a set of collections that are used to store version history
resources.
|
IResource |
IVersionResource.getVersionHistoryResource() |
IResource |
IVersionControlledResource.getVersionHistoryResource() |
RID |
IVersionResource.getVersionHistoryRID() |
RID |
IVersionControlledResource.getVersionHistoryRID() |
IResource |
IVersionHistoryResource.getVersionResourceByLabel(String label) |
IResourceList |
IVersionHistoryResource.getVersionResourceSet() |
RID |
IVersionHistoryResource.getVersionRIDByLabel(String label) |
IRidSet |
IVersionHistoryResource.getVersionRidSet() |
RID |
ICheckOutInfo2.getWorkingResourceRID() |
IRidSet |
IResourceMetadata.getWorkspaceCollectionSet()
Returns a set of collections that are able to contain/create workspace
resources.
|
RID |
IWorkspaceControlledResource.getWorkspaceRID() |
boolean |
ICollection.hasChildren()
True if the collection has at least one child resource
|
boolean |
IResource.isCheckedOut()
Returns
true if this resource is currently checked out. |
boolean |
IInternalLinkResource.isDynamic() |
boolean |
IVersionController.isEnabled() |
boolean |
IResource.isLocked()
Returns
true if this resource is locked. |
boolean |
IResource.isLockedByMe()
Returns
true if this resource is locked by the current user in
the context. |
static boolean |
MutableMultiLanguagedProperty.isMultiLanguaged(IProperty prop) |
boolean |
IInternalLinkResource.isPermanent() |
boolean |
IExternalLinkResource.isPermanent() |
static boolean |
RepositoryRootCheck.isRepositoryRoot(IResource res)
this method checks by
RID-comparison. |
static boolean |
Property.isSystemProperty(IPropertyName propName)
Returns true if it is the name of a system property
|
boolean |
IResource.isVersioned()
Returns
true if versioning is enabled for this resource. |
ILockInfo |
IResource.lock()
Lock the resource using the current user in the context.
|
ILockInfo |
IResource.lock(ILockProperties lockProperties)
Lock the resource using the current user in the context.
|
void |
MutableMultiLanguagedProperty.markAsTranslated() |
void |
IMutableMultiLanguagedProperty.markAsTranslated()
marks all languages as up-to-date
|
void |
MutableMultiLanguagedProperty.markAsTranslated(String languageTag) |
void |
IMutableMultiLanguagedProperty.markAsTranslated(String languageTag)
marks this language as up-to-date
|
IResource |
IResource.move(RID destinationRID,
ICopyParameter param)
Move the resource's content and properties
|
IResource |
IResource.move(RID destinationRID,
IPosition position,
ICopyParameter param)
Move the resource to a destination collection that supports ordered
children.
|
IResource |
IResource.move(URI destinationURI,
ICopyParameter param)
Deprecated.
As of EP 5.0 SP5, replaced by move() with RID parameter.
|
IResource |
IResource.move(URI destinationURI,
IPosition position,
ICopyParameter param)
Deprecated.
As of EP 5.0 SP5, replaced by move() with RID parameter.
|
void |
ISpecialMove.moveCreate(RID destinationRID,
ICopyParameter param)
Moves the resource to the destination RID like
IResource.move(RID, ICopyParameter)
but generates a create event (MoveCreateEvent). |
void |
ISpecialMove.moveDelete(RID destinationRID,
ICopyParameter param)
Moves the resource to the destination RID like
IResource.move(RID, ICopyParameter)
but generates a delete event (MoveDeleteEvent). |
boolean |
MutableMultiLanguagedProperty.needsTranslation(String languageTag) |
boolean |
IMultiLanguagedProperty.needsTranslation(String languageTag) |
static MutableProperty |
MutablePropertyInterpreter.newInstance_MutableProperty(MutableProperty instance,
IPropertyName name,
PropertyType type,
List values) |
static MutableProperty |
MutablePropertyInterpreter.newInstance_MutableProperty(MutableProperty instance,
IPropertyName name,
PropertyType type,
List values,
Properties attributes) |
static Property |
PropertyInterpreter.newInstance_Property(IPropertyName name,
PropertyType type,
List values) |
static PropertyDef |
PropertyDefInterpreter.newInstance_PropertyDef(PropertyType type,
boolean isMultivalued,
boolean isRequired,
boolean isReadonly,
boolean isIndexed,
boolean isHidden) |
static PropertyDef |
PropertyDefInterpreter.newInstance_PropertyDef(PropertyType type,
boolean isMultivalued,
boolean isRequired,
boolean isReadonly,
boolean isIndexed,
boolean isHidden,
Properties attributes) |
boolean |
PropertySelectorItem.pass(IProperty checkProp)
checks, if the given property will pass this selector or not.
|
void |
IResource.refreshLock(ILockInfo lockInfo)
Refresh the lock.
|
void |
MutableProperty.removeAttribute(String name) |
void |
MutableMultiLanguagedProperty.removeAttribute(String name) |
void |
IMutableProperty.removeAttribute(String name)
Removes a attribute
|
void |
IVersionResource.removeLabel(String labelName)
Removes the given label from the resource if present (removing non-existing
labels should be signaled through an exception)
|
void |
MutableProperty.removeValue(int index) |
void |
MutableMultiLanguagedProperty.removeValue(int index) |
void |
IMutableProperty.removeValue(int index)
Remove a value of a multi-value property
|
void |
IResource.rename(String newName)
Changes the name of this resource.
|
void |
ICollection.reorder(IReorderList list)
Change the position of some or all resources in an ordered collection.
|
IResourceList |
IResource.search(IQueryExpression query,
int depth,
int maxResults,
boolean includeRevisions)
Queries the resource and optionally the collection hierarchy for resources.
|
void |
IResource.setAsCurrentVersion()
Deprecated.
As of EP 5.0 SP5 This method will fail if it's not possible to
unambigously identify the version-controlled resource to be updated
(this may happen when working resources or workspaces are used).
Instead check out the version-controlled resource, copy the version
onto it, then check it back again.
|
void |
MutableProperty.setAttribute(String name,
String value) |
void |
MutableMultiLanguagedProperty.setAttribute(String name,
String value) |
void |
IMutableProperty.setAttribute(String name,
String value)
Set an attribute
|
void |
MutableProperty.setAttributes(Properties attributes) |
void |
MutableMultiLanguagedProperty.setAttributes(Properties attributes) |
void |
IMutableProperty.setAttributes(Properties attributes)
Set the complete collection of attributes
|
void |
MutableProperty.setBooleanValue(boolean value) |
void |
MutableMultiLanguagedProperty.setBooleanValue(boolean value) |
void |
IMutableProperty.setBooleanValue(boolean value)
Sets the property value if the type ist PropertyType.BOOLEAN
|
void |
MutableMultiLanguagedProperty.setBooleanValue(String languageTag,
boolean value) |
void |
IMutableMultiLanguagedProperty.setBooleanValue(String languageTag,
boolean value)
Sets the property value if the type ist PropertyType.BOOLEAN
|
void |
MutableProperty.setDateValue(Date value) |
void |
MutableMultiLanguagedProperty.setDateValue(Date value) |
void |
IMutableProperty.setDateValue(Date value)
Sets the property value if the type ist PropertyType.DATE
|
void |
MutableMultiLanguagedProperty.setDateValue(String languageTag,
Date value) |
void |
IMutableMultiLanguagedProperty.setDateValue(String languageTag,
Date value)
Sets the property value if the type ist PropertyType.DATE
|
void |
MutableProperty.setDateValueFromLong(long value) |
void |
MutableMultiLanguagedProperty.setDateValueFromLong(long value) |
void |
IMutableProperty.setDateValueFromLong(long value)
Sets the property value if the type ist PropertyType.DATE
|
void |
MutableMultiLanguagedProperty.setDateValueFromLong(String languageTag,
long value) |
void |
IMutableMultiLanguagedProperty.setDateValueFromLong(String languageTag,
long value)
Sets the property value if the type ist PropertyType.DATE
|
void |
MutableMultiLanguagedProperty.setDefaultLanguage(String languageTag) |
void |
IMutableMultiLanguagedProperty.setDefaultLanguage(String languageTag)
Specifies the default language.
|
void |
IMutableEntityMetadata.setEntityTag(String entityTag) |
void |
Content.setEntityTag(String entityTag) |
void |
MutableProperty.setIntValue(int value) |
void |
MutableMultiLanguagedProperty.setIntValue(int value) |
void |
IMutableProperty.setIntValue(int value)
Sets the property value if the type ist PropertyType.INTEGER
|
void |
MutableMultiLanguagedProperty.setIntValue(String languageTag,
int value) |
void |
IMutableMultiLanguagedProperty.setIntValue(String languageTag,
int value)
Sets the property value if the type ist PropertyType.INTEGER
|
void |
IVersionResource.setLabel(String labelName)
Sets the given label on the version (removing it from other versions if
present)
|
void |
IMutableEntityMetadata.setLastModified(Date lastModified) |
void |
Content.setLastModified(Date lastModified) |
static void |
ResourceInterpreter.setLinkType(IResource instance,
LinkType linkType)
Method with new enum signatures resembling method
IResource.getLinkType() |
void |
IResource.setLinkType(LinkType linkType)
Changes the link type.
|
void |
MutableProperty.setLongIntValue(long value) |
void |
MutableMultiLanguagedProperty.setLongIntValue(long value) |
void |
IMutableProperty.setLongIntValue(long value)
Sets the property value if the type ist PropertyType.LONG
|
void |
MutableMultiLanguagedProperty.setLongIntValue(String languageTag,
long value) |
void |
IMutableMultiLanguagedProperty.setLongIntValue(String languageTag,
long value)
Sets the property value if the type ist PropertyType.LONG
|
void |
ResourceContext.setObjectValue(String name,
Object value) |
void |
IResourceContext.setObjectValue(String name,
Object value)
Add/update a name/value pair
|
void |
IOrderableCollection.setOrderingType(IUri orderingType)
Sets the collection's ordering type.
|
static void |
CollectionInterpreter.setOrderType(ICollection instance,
OrderType type) |
void |
ICollection.setOrderType(OrderType orderType)
Set the order type of a collection
|
void |
IResource.setProperties(IPropertyMap props)
Set all properties of the resource.
|
void |
IResource.setProperties(List propChangeList)
Change the properties of the resource.
|
void |
IResource.setProperty(IProperty prop)
Sets a property.
|
void |
MutableProperty.setStringValue(String value) |
void |
MutableMultiLanguagedProperty.setStringValue(String value) |
void |
IMutableProperty.setStringValue(String value)
Sets the property value if the type ist PropertyType.STRING
|
void |
MutableMultiLanguagedProperty.setStringValue(String languageTag,
String value) |
void |
IMutableMultiLanguagedProperty.setStringValue(String languageTag,
String value)
Sets the property value if the type ist PropertyType.STRING
|
void |
IInternalLinkResource.setTargetRID(RID target)
Sets the link target.
|
void |
IExternalLinkResource.setTargetUri(IUri target)
Deprecated.
|
void |
IExternalLinkResource.setTargetUriReference(IUriReference target)
Sets the link target.
|
void |
IResource.setTargetURL(URL url)
Changes the target URL of a link.
|
void |
MutableProperty.setValue(int index,
Object value) |
void |
MutableMultiLanguagedProperty.setValue(int index,
Object value) |
void |
IMutableProperty.setValue(int index,
Object value)
Set a value of a multi-value property
|
void |
ResourceContext.setValue(String name,
String value) |
void |
IResourceContext.setValue(String name,
String value)
Add/update a name/value pair
|
void |
MutableProperty.setValues(List values) |
void |
MutableMultiLanguagedProperty.setValues(List values) |
void |
IMutableProperty.setValues(List values)
Sets all values of a multi-value property
|
boolean |
IBindableResource.supportsAdditionalBinds() |
void |
IResource.undoCheckOut()
Undo a previous check out operation.
|
void |
IResource.unlock(ILockInfo lockInfo)
Unlock the resource using the current user in the context.
|
void |
IResource.update(IContent newContent,
IPropertyMap properties)
Updates the content and properties of this resource in an atomic operation.
|
void |
IResource.updateContent(IContent newContent)
Updates the content of this resource.
|
IRidSet |
IVersionControlledResource.updateFromVersion(IResource version)
update content and dead properties from a specific version.
|
IRidSet |
IVersionControlledResource.updateFromVersion(RID version)
update content and dead properties from a specific version.
|
protected void |
Property.validateType(Object v)
Validates the instance of the property value
|
| Constructor and Description |
|---|
DestinationNotSupportedException(ResourceException newEx)
This constructor is used by the framework to use this exception as a
wrapper for a new exception class of the repository manager API.
|
IncompleteOperationException(ResourceException firstException,
RID resourceID)
Constructs a new exception
|
IncompleteOperationException(ResourceException firstException,
URI resourceID)
Deprecated.
as of NW04.
URI migrated to RID . |
IncompleteOperationException(String msg,
ResourceException firstException,
RID resourceID)
Constructs a new exception
|
IncompleteOperationException(String msg,
ResourceException firstException,
URI resourceID)
Deprecated.
as of NW04.
URI migrated to RID . |
PropertyChangeResult(IPropertyName propertyName,
Integer propChangeIdx,
ResourceException ex)
Construct a new PropertyChangeResult.
|
| Constructor and Description |
|---|
MutableMultiLanguagedProperty(IPropertyName name,
IPropertyDef def,
Locale locale) |
MutableMultiLanguagedProperty(IPropertyName name,
Locale locale) |
MutableProperty(IPropertyName name,
Boolean value)
Construct a new property of type BOOLEAN.
|
MutableProperty(IPropertyName name,
Boolean value,
Properties attributes)
Construct a new property of type BOOLEAN.
|
MutableProperty(IPropertyName name,
Date value)
Construct a new property of type DATE.
|
MutableProperty(IPropertyName name,
Date value,
Properties attributes)
Construct a new property of type DATE.
|
MutableProperty(IPropertyName name,
Integer value)
Construct a new property of type INTEGER.
|
MutableProperty(IPropertyName name,
Integer value,
Properties attributes)
Construct a new property of type INTEGER.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Boolean value)
Construct a new property of type BOOLEAN.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Boolean value,
Properties attributes)
Construct a new property of type BOOLEAN.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Date value)
Construct a new property of type DATE.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Date value,
Properties attributes)
Construct a new property of type DATE.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Integer value)
Construct a new property of type INTEGER.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Integer value,
Properties attributes)
Construct a new property of type INTEGER.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
List values)
Construct a new multi-valued property.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
List values,
Properties attributes)
Construct a new multi-valued property.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Long value)
Construct a new property of type LONG.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Long value,
Properties attributes)
Construct a new property of type LONG.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Object value)
Construct a new property.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
Object value,
Properties attributes)
Construct a new property.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
String value)
Construct a new property of type STRING.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
String value,
Properties attributes)
Construct a new property of type STRING.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
XMLMarkup value)
Construct a new property of type XML.
|
MutableProperty(IPropertyName name,
IPropertyDef def,
XMLMarkup value,
Properties attributes)
Construct a new property of type XML.
|
MutableProperty(IPropertyName name,
Long value)
Construct a new property of type LONG.
|
MutableProperty(IPropertyName name,
Long value,
Properties attributes)
Construct a new property of type LONG.
|
MutableProperty(IPropertyName name,
Object value)
Construct a new property.
|
MutableProperty(IPropertyName name,
Object value,
Properties attributes)
Construct a new property.
|
MutableProperty(IPropertyName name,
PropertyType type,
List values)
Construct a new multi-valued property.
|
MutableProperty(IPropertyName name,
PropertyType type,
List values,
Properties attributes)
Construct a new multi-valued property.
|
MutableProperty(IPropertyName name,
String value)
Construct a new property of type STRING.
|
MutableProperty(IPropertyName name,
String value,
Properties attributes)
Construct a new property of type STRING.
|
MutableProperty(IPropertyName name,
XMLMarkup value)
Construct a new property of type XML.
|
MutableProperty(IPropertyName name,
XMLMarkup value,
Properties attributes)
Construct a new property of type XML.
|
Property(IPropertyName name,
Boolean value)
Construct a new property of type BOOLEAN.
|
Property(IPropertyName name,
Boolean value,
Properties attributes)
Construct a new property of type BOOLEAN.
|
Property(IPropertyName name,
Date value)
Construct a new property of type DATE.
|
Property(IPropertyName name,
Date value,
Properties attributes)
Construct a new property of type DATE.
|
Property(IPropertyName name,
Integer value)
Construct a new property of type INTEGER.
|
Property(IPropertyName name,
Integer value,
Properties attributes)
Construct a new property of type INTEGER.
|
Property(IPropertyName name,
IPropertyDef def) |
Property(IPropertyName name,
IPropertyDef def,
Boolean value)
Construct a new property of type BOOLEAN.
|
Property(IPropertyName name,
IPropertyDef def,
Boolean value,
Properties attributes)
Construct a new property of type BOOLEAN.
|
Property(IPropertyName name,
IPropertyDef def,
Date value)
Construct a new property of type DATE.
|
Property(IPropertyName name,
IPropertyDef def,
Date value,
Properties attributes)
Construct a new property of type DATE.
|
Property(IPropertyName name,
IPropertyDef def,
Integer value)
Construct a new property of type INTEGER.
|
Property(IPropertyName name,
IPropertyDef def,
Integer value,
Properties attributes)
Construct a new property of type INTEGER.
|
Property(IPropertyName name,
IPropertyDef def,
List values)
Construct a new multi-valued property.
|
Property(IPropertyName name,
IPropertyDef def,
List values,
Properties attributes)
Construct a new multi-valued property.
|
Property(IPropertyName name,
IPropertyDef def,
Long value)
Construct a new property of type LONG.
|
Property(IPropertyName name,
IPropertyDef def,
Long value,
Properties attributes)
Construct a new property of type LONG.
|
Property(IPropertyName name,
IPropertyDef def,
Object value)
Construct a new property.
|
Property(IPropertyName name,
IPropertyDef def,
Object value,
Properties attributes)
Construct a new property.
|
Property(IPropertyName name,
IPropertyDef def,
String value)
Construct a new property of type STRING.
|
Property(IPropertyName name,
IPropertyDef def,
String value,
Properties attributes)
Construct a new property of type STRING.
|
Property(IPropertyName name,
IPropertyDef def,
XMLMarkup value)
Construct a new property of type XML.
|
Property(IPropertyName name,
IPropertyDef def,
XMLMarkup value,
Properties attributes)
Construct a new property of type XML.
|
Property(IPropertyName name,
Long value)
Construct a new property of type LONG.
|
Property(IPropertyName name,
Long value,
Properties attributes)
Construct a new property of type LONG.
|
Property(IPropertyName name,
Object value)
Construct a new property.
|
Property(IPropertyName name,
Object value,
Properties attributes)
Construct a new property.
|
Property(IPropertyName name,
PropertyType type,
boolean isMultivalued) |
Property(IPropertyName name,
PropertyType type,
List values)
Construct a new multi-valued property.
|
Property(IPropertyName name,
PropertyType type,
List values,
Properties attributes)
Construct a new multi-valued property.
|
Property(IPropertyName name,
String value)
Construct a new property of type STRING.
|
Property(IPropertyName name,
String value,
Properties attributes)
Construct a new property of type STRING.
|
Property(IPropertyName name,
XMLMarkup value)
Construct a new property of type XML.
|
Property(IPropertyName name,
XMLMarkup value,
Properties attributes)
Construct a new property of type XML.
|
PropertyDef(PropertyType type,
boolean isMultivalued,
boolean isRequired,
boolean isReadonly,
boolean isIndexed,
boolean isHidden)
Constructs a new PropertyDef
|
PropertyDef(PropertyType type,
boolean isMultivalued,
boolean isRequired,
boolean isReadonly,
boolean isIndexed,
boolean isHidden,
Properties attributes)
Constructs a new PropertyDef
|
PropertyName(Name name)
Deprecated.
since NW04 SPS19 / NW04s SP10,
please use PropertyName.getPN() instead
|
PropertyName(String namespace,
String name)
Deprecated.
since NW04 SPS19 / NW04s SP10,
please use PropertyName.getPN() instead
|
| Modifier and Type | Method and Description |
|---|---|
Map |
IResourceBatch.getLocksInfo()
Returns a map containing lock information for the resources in this resource batch.
|
Map |
IResourceBatch.getProperties(IPropertyNameList propNameList,
ResourceErrors errors)
Returns a map containing the requested properties which are available for the resources in this resource batch.
|
| Modifier and Type | Method and Description |
|---|---|
LinkType |
EnumInterpreter.getLinkType(IResource resource)
Method with new enum signatures resembling method
IResource.getLinkType() |
void |
EnumInterpreter.setLinkType(IResource resource,
LinkType linkType)
Method with new enum signatures resembling method
IResource.getLinkType() |
| Modifier and Type | Class and Description |
|---|---|
class |
FilterConfigurationException
The application tried to check out a resource that is not versioned.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IArchivingSession.commit()
Commits the operations from the session.
|
void |
IArchivingSession.createResource(RID parentRID,
String name,
IPropertyMap properties,
IContent content)
Creates non-versioned resource in the archiving backend.
|
void |
IArchivingSession.createResource(RID parentRID,
String name,
IPropertyMap properties,
IContent content,
RID vhr)
Creates versioned resource in the archiving backend.
|
void |
IArchivingSession.createRevision(RID vhrID,
String name,
IPropertyMap properties,
IContent content,
String revisionID)
Creates revision in the archiving backend.
|
RID |
IArchivingSession.createVHR()
Creates a folder (version history resource) which stores all versions for a resource.
|
IResourceList |
IPropertySearchManager.execute(IQueryExpression query,
IResource resource,
int depth,
int maxResults,
boolean includeVersions)
Runs a query and returns a list of resource that matched the criteria.
|
RID |
IArchivingSession.getAbsoluteRID(RID relativeRID)
Computes the absolute RID for a given relative RID.
|
Collection |
IManagerFactory.getAllRepositoryManagers()
Returns a list of all available repository managers
|
Collection |
IManagerFactory.getAllRepositoryManagers(String className)
Returns a collection of all available repository managers that are
instances of the specified class
|
Collection |
IRepositoryManager.getAllServices()
Deprecated.
As of EP 5.0 SP5
|
RID |
IAclInheritanceController.getLegator(RID currentResource,
IResourceContext context)
Returns the legator of a resource given by its
RID. |
IPropertySearchManager |
IRepositoryManager.getPropertySearchManager(IResource resource)
Get a reference to the property search manager for the repository
|
IRepositoryManager |
IManagerFactory.getRepositoryManager(RID rid)
Returns the repository manager instance for a given resource identifier
|
IRepositoryManager |
IManagerFactory.getRepositoryManager(String id)
Returns the instance of a repository manager for a given ID or
null
. |
ISecurityManager |
IRepositoryManager.getSecurityManager(IResource resource)
Get a reference to the security manager for the repository
|
IRepositoryService |
IRepositoryManager.getService(String type)
Deprecated.
As of EP 5.0 SP5, replaced by getService() method in
IRepositoryServiceFactory
|
IPermissionList |
ISecurityManager.getSupportedPermissions(IResource resource)
Returns a a list of permissions which are supported by the security manager
for a specific resource (the result depends on wether the resource is a
collection or not)
|
boolean |
ISecurityManager.isAllowed(IResource resource,
com.sapportals.portal.security.usermanagement.IUser user,
IPermission permission)
Deprecated.
As of NetWeaver 7.1, replaced by
ISecurityManager.isAllowed(IResource,com.sap.security.api.IUser,IPermission) |
boolean |
ISecurityManager.isAllowed(IResource resource,
IUser user,
IPermission permission)
Checks, whether a user has a specific permission on a specific resource
|
boolean |
ISecurityManager.isAllowed(IResource resource,
com.sapportals.portal.security.usermanagement.IUser user,
IPermissionList permissions)
Deprecated.
As of NetWeaver 7.1, replaced by
ISecurityManager.isAllowed(IResource,com.sap.security.api.IUser,IPermissionList) |
boolean |
ISecurityManager.isAllowed(IResource resource,
IUser user,
IPermissionList permissions)
Checks, whether a user has some permissions on a specific resource
|
IRidSet |
ISecurityManager.isAllowed(IRidList ridList,
com.sapportals.portal.security.usermanagement.IUser user,
IPermissionList permissions,
IResourceContext context)
Deprecated.
As of NetWeaver 7.1, replaced by
ISecurityManager.isAllowed(IRidList,com.sap.security.api.IUser,IPermissionList,IResourceContext) |
IRidSet |
ISecurityManager.isAllowed(IRidList ridList,
IUser user,
IPermissionList permissions,
IResourceContext context)
Checks, whether a user has some permissions on all specified resources.
|
boolean |
IRepositoryManager.isServiceAvailable(String type)
Deprecated.
As of EP 5.0 SP5, replaced by getService() method in
IRepositoryServiceFactory
|
void |
IArchivingSession.rollback()
Rollbacks the operations from the session.
|
| Modifier and Type | Method and Description |
|---|---|
IPropertyMap |
IEntryPointsProvider.getProperties(IResource resource,
IEntryPoint entryPoint,
DisplayMode displayMode)
Gets properties of an entry point represented by a resource
|
IPropertyMap |
AbstractEntryPointsProvider.getProperties(IResource resource,
IEntryPoint entryPoint,
DisplayMode displayMode)
Gets properties of an entry point represented by a resource
|
protected IPropertyMap |
AbstractEntryPointsProvider.getPropertiesForInternalLink(RID targetRid,
IResourceContext context,
boolean nameAsFallback) |
IProperty |
IEntryPointsProvider.getProperty(IPropertyName propertyName,
IResource resource,
IEntryPoint entryPoint,
DisplayMode displayMode)
Gets a property of an entry point represented by a resource
|
IProperty |
AbstractEntryPointsProvider.getProperty(IPropertyName propertyName,
IResource resource,
IEntryPoint entryPoint,
DisplayMode displayMode)
Gets a property of an entry point represented by a resource
|
protected IProperty |
AbstractEntryPointsProvider.getPropertyForInternalLink(IPropertyName propertyName,
RID targetRid,
IResourceContext context,
boolean nameAsFallback)
Gets a property for an internal link.
|
| Modifier and Type | Method and Description |
|---|---|
static IProperty |
EntryPointFilterProperty.createPropertyNever()
Creates a property instance with the value that must be set if a resource should never be displayed.
|
static IProperty |
EntryPointFilterProperty.createPropertyNotInMenue()
Creates a property instance with the value that must be set if a resource should not be displayed in a menue.
|
| Constructor and Description |
|---|
ProviderPrioPropertyName() |
ShowChildrenPropertyName() |
| Modifier and Type | Method and Description |
|---|---|
IResourceList |
IGenericQuery.execute(IResource resource,
int depth,
int maxResults,
boolean includeVersions)
Runs this query and returns a list of resources that matched the criteria.
|
IQueryExpression |
IGenericQueryFactory.fromXml(String persistedQuery)
Transforms a persisted query (obtained from
IGenericQueryFactory.fromXml(String) back into a generic query expression. |
static IGenericQueryFactory |
GenericQueryFactory.getInstance()
Returns a reference to the resource factory instance.
|
String |
IGenericQueryFactory.toXml(IQueryExpression queryExpression)
Transforms a generic query expression into a plain string that can be
persisted.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
IResourceAcl.addEntry(IResourceAclEntry aclEntry)
add an ACE to the ACL
|
boolean |
IResourceAcl.addOwner(IPrincipal owner)
add a new owner to the ACL (only owners are allowed to change the ACL)
|
boolean |
IResourceAcl.addOwner(com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
Deprecated.
As of NetWeaver 7.1, replaced by
IResourceAcl.addOwner(com.sap.security.api.IPrincipal) |
boolean |
IResourceAclManager.assignForeignAcl(IResourceAcl foreignAcl,
IResource resource)
assign an ACL from a foreign IResourceAclManager to a local resource -
foreign ACEs which hold permissions that are not supported by the local
IResourceAclManager are ignored - locally inherited ACEs are added - the
owners are maintained - if the resource inherits an ACL the user must be an
owner - fails, if the resource already has an ACL assigned
|
IResourceAcl |
IResourceAclManager.createAcl(IResource resource)
create a new ACL for a resource - initial owner is the user in the resource
context - inherited ACEs are added - if the resource inherits an ACL the
user must be an owner - fails, if the resource already has an ACL assigned
|
IResourceAcl |
IResourceAclManager4Tx.createAcl(IResource resource,
IResourceAclEntryList entries,
IUMPrincipalList owners)
Deprecated.
As of NetWeaver 7.1 replaced by
IResourceAclManager4Tx.createAcl(IResource, IResourceAclEntryList, List) |
IResourceAcl |
IResourceAclManager4Tx.createAcl(IResource resource,
IResourceAclEntryList entries,
List owners)
create a new ACL for a resource - initial owner is the user in the resource
context - inherited ACEs are added - if the resource inherits an ACL the
user must be an owner - fails, if the resource already has an ACL assigned
|
IResourceAcl |
IResourceAclManager.getAcl(IResource resource)
get the ACL of a specific resource
|
IResourceAcl |
IResourceAclManagerRaw.getAclRaw(IResource resource)
Get the - potentially raw - ACL of a specific resource.
|
IResourceAcl |
IResourceAclManager.getInheritedAcl(IResource resource)
get the ACL that a resource inherits by its ancestors
|
IObjectType |
IResourceAclManager.getObjectType(IResource resource)
get the object type of a resource
|
IAclPermissionList |
IResourceAclManager.getSupportedPermissions(IResource resource)
get a list of permissions which are supported by the IResourceAclManager
for a specific resource
|
IResourceList |
IResourceAclManager.propagateAcl_Remove(IResource resource)
remove the ACLs of the descendants of the resource
|
boolean |
IResourceAclManager.removeAcl(IResource resource)
remove the ACL of a specific resource
|
boolean |
IResourceAclManager.removeAcl(IResource resource)
remove the ACL of a specific resource
|
boolean |
IResourceAclManager.removeAcl(IResourceAcl acl)
remove an ACL
|
boolean |
IResourceAcl.removeEntry(IResourceAclEntry aclEntry)
remove an ACE from the ACL
|
boolean |
IResourceAcl.removeOwner(IPrincipal owner)
remove an owner from the ACL (only owners are allowed to change the ACL)
|
boolean |
IResourceAcl.removeOwner(com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
Deprecated.
As of NetWeaver 7.1, replaced by
IResourceAcl.removeOwner(com.sap.security.api.IPrincipal) |
boolean |
IResourceAcl4Tx.set(IResourceAclEntryList entries,
IUMPrincipalList owners)
Deprecated.
As of NetWeaver 7.1, replaced by
IResourceAcl4Tx.set(IResourceAclEntryList, java.util.List) |
boolean |
IResourceAcl4Tx.set(IResourceAclEntryList entries,
List owners)
(re)set the entries and owners for the ACL.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ServiceCallException
Indicates an error during a
IRepositoryService.acceptServletCall(Properties, IResourceContext)
call. |
class |
ServiceNotAvailableException
Indicates that a repository service will not be available at one or more
repositories.
|
| Modifier and Type | Method and Description |
|---|---|
String |
IRepositoryService.acceptServletCall(Properties properties,
IResourceContext context)
This method is called by the
eServiceServlet to perform some
action. |
String |
AbstractRepositoryService.acceptServletCall(Properties properties,
IResourceContext context) |
Collection |
IRepositoryServiceFactory.getAllRepositoryServices(IRepositoryManager repository)
Get a list of all registered repository services for a given repository
manager.
|
Collection |
IRepositoryServiceFactory.getAllRepositoryServices(IResource resource)
Get all repository services for a given resources repository manager.
|
Collection |
IRepositoryServiceFactory.getAllServices()
Returns a collection of all defined global services
|
IRepositoryService |
IRepositoryServiceFactory.getRepositoryService(IRepositoryManager repository,
String servicetype)
Returns a specific repository service instance for a given repository manager.
|
IRepositoryService |
IRepositoryServiceFactory.getRepositoryService(IResource resource,
String servicetype)
Get a specific service for a given resource.
|
IRepositoryService |
IRepositoryServiceFactory.getRepositoryService(String id)
Retrieves a repository service by a given ID.
|
IService |
IRepositoryServiceFactory.getService(String serviceID)
Retrieves a global service by a given ID.
|
boolean |
IRepositoryServiceFactory.isRepositoryServiceAvailable(IRepositoryManager repository,
String servicetype)
Checks if the service is avaible.
|
boolean |
IRepositoryServiceFactory.isRepositoryServiceAvailable(IResource resource,
String servicetype)
Checks if the service is avaible.
|
| Constructor and Description |
|---|
AbstractRepositoryService(Properties properties)
Deprecated.
As of EP 5.0 SP5, replaced by the default (public, no
arguments) constructor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DiscussionResourceTypeException
Indicates that setting or getting a resource type of a discussion resource
was not successful.
|
class |
DiscussionSingleTopicExistsException
Indicates that creation of a single topic, while running the discussion service
without topic level, was not successful, because this single topic exists yet.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
IDiscussionItem.canDeleteChild(IDiscussionItem item)
Checks if the deletion of a child discussion item is possible.
|
boolean |
IDiscussion.canDeleteItem(IDiscussionItem topic)
Checks if the deletion of a topic discussion item is possible.
|
IDiscussionItem |
IDiscussion.createItem(IDiscussionItem parent,
String name,
String content,
String description)
Creates a discussion item within a thread.
|
IDiscussionItem |
IDiscussion.createItem(String name,
String content,
String description)
Creates first topic of a discussion thread (root discussion item also called topic).
|
IDiscussionItem |
IDiscussion.createSingleTopic()
Creates first topic of a discussion thread (root discussion item also called topic).
|
void |
IDiscussion.deleteItem(IDiscussionItem item)
Deletes a discussion item.
|
void |
IDiscussion.deleteItemReplies(IDiscussionItem item)
Deletes a the replies folder of discussion item.
|
void |
IDiscussion.deleteItemReplies(IResource itemResource)
Deletes a the replies folder of discussion item.
|
IProperty |
IDiscussionItem.getAuthor()
Gets the author of an
IDiscussionItem. |
IDiscussionItemList |
IDiscussionItem.getChildren()
Gets all replies to this
IDiscussionItem. |
IDiscussionItemList |
IDiscussionItem.getChildren(IDiscussionItem branchItem) |
IDiscussionItemList |
IDiscussion.getChildren(IDiscussionItem item)
Deprecated.
as of NW04. Replaced by method of
IDiscussionItem |
IContent |
IDiscussionItem.getContent()
Deprecated.
as of NW04.
|
IProperty |
IDiscussionItem.getDate()
Gets the creation date of the
IDiscussionItem. |
String |
IDiscussionItem.getDescription()
Gets the description of the
IDiscussionItem. |
IDiscussionItem |
IDiscussion.getDiscussionItem(RID itemRid)
Gets the
IDiscussionItem instance for the specified RID. |
IDiscussionManager |
IDiscussion.getDiscussionManager()
Gets DiscussionManager for interactions between discussion classes.
|
IProperty |
IDiscussionItem.getName()
Gets the name of an
IDiscussionItem. |
int |
IDiscussionItem.getNumberOfPosts()
Gets the number of posts that belong to discussion topic.
|
int |
IDiscussionItem.getNumberOfPosts(IDiscussionItem branchItem)
Gets the number of posts that belong to discussion topic.
|
int |
IDiscussion.getNumberOfThreads()
Deprecated.
as of NW04. Replaced by getNumberOfTopics()
|
int |
IDiscussion.getNumberOfTopics()
Gets the number of threads that belong to the discussion.
|
IDiscussionItem |
IDiscussionItem.getParent()
Gets the parent IDiscussionItem instance.
|
IDiscussionItem |
IDiscussion.getParent(IDiscussionItem item)
Deprecated.
as of NW04. Replaced by
getParent method at IDiscussionItem |
IDiscussionItemList |
IDiscussionItem.getPosts(String sortCriterion,
String sortDirection,
IDiscussionItem branchItem,
IDiscussionItem selectedItem,
int startIndex,
int length)
Gets a set (page) of discussion items of a discussion topic.
|
IDiscussionItemList |
IDiscussionItem.getPostsInTreeOrder()
Gets all discussion items of a discussion topic.
|
String |
IDiscussionItem.getPostStartingText() |
IResource |
IDiscussion.getPrimaryResource()
Gets primary resource of the discussion.
|
ICollection |
IDiscussionItem.getReplyCollection()
Get the ReplyCollection attribute of the IDiscussionItem object.
|
IResource |
IDiscussionItem.getResource()
Gets the discussion item as an
IResource object. |
String |
IDiscussionItem.getSubject() |
IDiscussionItemList |
IDiscussion.getThreads()
Deprecated.
as of NW04. Replaced by getTopics()
|
IDiscussionItemList |
IDiscussion.getTopics()
Gets all topics that belong to the discussion.
|
IDiscussionItemList |
IDiscussion.getTopics(String sortCriterion,
String sortDirection)
Gets all topics that belong to the discussion.
|
IDiscussionItemList |
IDiscussion.getTopics(String sortCriterion,
String sortDirection,
int startIndex,
int length)
Gets set of topics that belong to the discussion.
|
DiscussionItemType |
IDiscussionItem.getType()
Gets the type of a discussion item.
|
boolean |
IDiscussionItem.hasChildren()
Gets flag that shows whether the discussion item has replies.
|
boolean |
IDiscussion.hasChildren(IDiscussionItem item)
Deprecated.
as of NW04. Replaced by the
hasChildren() of the IDiscussion interface |
boolean |
IDiscussion.isSingleTopic(IDiscussionItem item)
Returns
true if specified IDiscussionItem is a discussion topic and has the same
description as a single topic. |
void |
IDiscussionItem.setType(DiscussionItemType type)
Sets the type of a discussion item.
|
boolean |
IDiscussion.withTopics()
Gets a flag that indicates if the discussion is running with topics or without topic layer.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
IAclService.isAllowed(IResource resource,
com.sapportals.portal.security.usermanagement.IUser user,
IAclPermission permission)
Deprecated.
as of NetWeaver 7.1,
replaced by
IAclService.isAllowed(IResource, com.sap.security.api.IUser, IAclPermission) |
boolean |
IAclService.isAllowed(IResource resource,
IUser user,
IAclPermission permission) |
| Modifier and Type | Method and Description |
|---|---|
static IPropertyName |
SMConstants.getStatePropName()
returns the PropertyName object for the state application property
|
static IPropertyName |
SMConstants.getWorkflowInitiatorPropName()
returns the PropertyName object for the workflow initiator application property
|
static IPropertyName |
SMConstants.getWorkflowStatePropName()
Returns the PropertyName object for the workflow state application property
|
| Modifier and Type | Method and Description |
|---|---|
static IPropertyName |
TimebasedPublishConstants.getDisplayValidFromPropName()
Gets the name of the property which is displayed as the
'valid from' property for a resource.
|
static IPropertyName |
TimebasedPublishConstants.getDisplayValidToPropName()
Gets the name of the property which is to be displayed as the
'valid until' property for a resource.
|
static IPropertyName |
TimebasedPublishConstants.getDisplayValidToXdaysPropName()
Gets the name of the property which is to be displayed as the
'How many days before validity expires' when lifetime is activated on folder
|
static IPropertyName |
TimebasedPublishConstants.getTimebasePublishEnabledName()
Gets the name of the property which determines if time-based publishing is
enabled for a resource.
|
static IPropertyName |
TimebasedPublishConstants.getValidFromPropName()
Gets the name of the property which determines the point in time at which
a resource is to be made visible by the scheduler task.
|
static IPropertyName |
TimebasedPublishConstants.getValidToPropName()
Gets the name of the property which determines the point in time at which
a resource is to be made invisible by the scheduler.
|
static IPropertyName |
TimebasedPublishConstants.getValidToXdaysPropName()
Gets the name of the property which determines how many days before the resource becomes invisible, the subscribed users should receive a notification.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SoException |
| Modifier and Type | Method and Description |
|---|---|
Object |
IObjectFactory.as(Class classRef,
IResource resource) |
Object |
DefaultObjectFactory.as(Class classRef,
IResource resource) |
static IObjectFactoryRegistry |
ObjectFactoryRegistry.getInstance()
Return a reference to the singleton factory instance !!!
|
boolean |
IObjectFactory.isA(Class classRef,
IResource resource)
Get the A attribute of the ITypeCastProvider object.
|
boolean |
DefaultObjectFactory.isA(Class interfaceRef,
IResource resource)
Get the A attribute of the DefaultTypeCastProvider object.
|
| Modifier and Type | Method and Description |
|---|---|
static boolean |
ResourceTypeUtil.isA(IResource resource,
String resourceType)
Checks if a resource is of a given resourceType.
|
| Modifier and Type | Class and Description |
|---|---|
class |
InvalidVariantContextException
Thrown by a variant-enabled repository if the variant context (
)
is missing or invalid. |
class |
PhysicalResourceAlreadyExistsException
|
| Modifier and Type | Method and Description |
|---|---|
IResource |
ILogicalVariantResource.createPhysicalResource(IContent content,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new physical resource for this logical resource.
|
void |
ILogicalVariantResource.deleteInvariantProperty(IPropertyName propertyName)
Deletes the invariant property with the specified name if it exists.
|
IResourceList |
ILogicalVariantResource.findPhysicalResources(IPropertyMap properties)
Returns a list of resource instances of type
IPhysicalVariantResource which match the given map of context
properties. |
IPropertyMap |
ILogicalVariantResource.getInvariantProperties(IPropertyNameList list)
Returns a map of invariant properties with the specified names or all properties if the list is null.
|
IProperty |
ILogicalVariantResource.getInvariantProperty(IPropertyName name)
Returns an invariant property with the given name or
null if it does not exist. |
IResource |
IPhysicalVariantResource.getLogicalResource()
Returns the logical resource this physical resource belongs to.
|
IResource |
ILogicalVariantResource.getPhysicalResource()
Returns the physical resource that was the result of the context resultion for this resource (at the time when this
resource was created).
|
void |
ILogicalVariantResource.setInvariantProperty(IProperty property)
Sets the specified property as a invariant property of this logical resource.
|
void |
ILogicalVariantResource.updateInvariantProperties(List updates)
Updates the invariant properties of this resource.
|
| Constructor and Description |
|---|
LinkDataPack(IPropertyMap properties,
IResource target)
Convenience constructor to create a link of type
LinkType.INTERNAL. |
LinkDataPack(String name,
IPropertyMap properties,
IResource target)
Convenience constructor to create a link of type
LinkType.INTERNAL. |
| Modifier and Type | Method and Description |
|---|---|
ISubSubscription |
ISubSyndicator.createSubscription(String name,
String subscriptionId,
String offerId,
ICEDeliveryPolicy deliverPolicy,
RID destinationRID,
IResourceContext context)
Create a new subscription of the syndicator.
|
ISubSyndicator |
ISubscriberConfig.createSyndicator(String name,
String description,
UUID uuid,
URL url,
IResourceContext context)
Create a new syndicator.
|
void |
ISubSyndicator.removeSubscription(ISubSubscription subscription,
IResourceContext context)
Remove a subscription of the syndicator.
|
void |
ISubscriberConfig.removeSyndicator(ISubSyndicator syndicator,
IResourceContext context)
Remove a syndicator from the configuration.
|
void |
ISubSubscription.resetState(IResourceContext context)
Reset the subscription to intial state.
|
void |
ISubSyndicator.setCachedOffers(Collection cachedOffers,
IResourceContext context)
Set/update the cached offers of the syndicator.
|
void |
ISubscriberConfig.setDefaultLogin(String user,
String password,
IResourceContext context)
Set the login informations of the default user.
|
void |
ISubSubscription.setDeliveryPolicy(ICEDeliveryPolicy deliveryPolicy,
IResourceContext context)
Set/change the negotiated delivery policy for this subscription.
|
void |
ISubSyndicator.setDescription(String description,
IResourceContext context)
Set the description of the syndicator.
|
void |
ISubSubscription.setDestinationRID(RID destinationRID,
IResourceContext context)
Set the uri where to store the packages from the syndicator.
|
void |
ISubscriberConfig.setLocation(URL location,
IResourceContext context)
Set the location of the ICE servlet on this machine.
|
void |
ISubSyndicator.setLoginInfo(String user,
String password,
IResourceContext context)
Set the (default) login informations of the syndicator.
|
void |
ISubSubscription.setMailFrom(String mailFrom,
IResourceContext context)
Set the name of the e-mail sender of mails with a content update file.
|
void |
ISubSubscription.setMailRepository(String mailRepository,
IResourceContext context)
Set the name of the e-mail repository where the mails of the subscriber are stored.
|
void |
ISubSubscription.setMailSubject(String mailSubject,
IResourceContext context)
Set the name of the e-mail subject of mails with a content update file.
|
void |
ISubSyndicator.setName(String name,
IResourceContext context)
Set name of the syndicator.
|
void |
ISubSubscription.setName(String name,
IResourceContext context)
Set the name of the subscription.
|
void |
ISubscriberConfig.setName(String subscriberName,
IResourceContext context)
Set the name/description of the subscriber.
|
void |
ISubSyndicator.setURL(URL url,
IResourceContext context)
Set the URL of the syndicator (ICE-Servlet).
|
void |
ISubSyndicator.setUUID(UUID uuid,
IResourceContext context)
Set the UUID of the syndicator.
|
void |
ISubscriberConfig.setUUID(UUID subscriberUUID,
IResourceContext context)
Set the uuid of the subscriber.
|
void |
ISubSyndicator.setWCMSystem(boolean isWCMSystem,
IResourceContext context)
Mark the syndicator as WCM system.
|
| Modifier and Type | Method and Description |
|---|---|
IOfferComponent |
IOffer.createComponent(String name,
RID rootRID,
String prefix,
IResourceContext context)
Create a new offer component.
|
IOffer |
ISyndicatorConfig.createOffer(String offerId,
IResourceContext context)
Create a new offer.
|
ISynSubscriber |
ISyndicatorConfig.createSubscriber(String name,
String description,
UUID uuid,
IResourceContext context)
Create a new subscriber.
|
ISynSubscription |
ISynSubscriber.createSubscription(String name,
String subscriptionId,
ICEDeliveryPolicy deliveryPolicy,
IOffer offer,
IResourceContext context)
Create a new subscription for the subscriber.
|
void |
IOfferComponent.defineFilter(int depthFilter,
String nameFilter,
long maxSizeFilter,
Date minCreationDate,
Date maxCreationDate,
IResourceContext context)
Define the filter for this offer.
|
ICEAccess |
IContentFilter.getAccess(IResource resource)
Get the access rules for the resource content.
|
String |
IContentFilter.getContentReference(IResource resource)
Check if the resource content should be transfered as ICE item reference.
|
InputStream |
ISyndicatorConfig.getGlobalPackage(boolean incremental,
boolean compressed,
IResourceContext context)
Get an ICE package containing the content of the global offer.
|
InputStream |
ISynSubscription.getPackage(boolean incremental,
boolean compressed,
IResourceContext context)
Get an ICE package of this subscription.
|
void |
IOffer.removeComponent(IOfferComponent component,
IResourceContext context)
Remove an offer component.
|
void |
ISyndicatorConfig.removeOffer(IOffer offer,
IResourceContext context)
Remove an offer from the configuration.
|
void |
ISyndicatorConfig.removeSubscriber(ISynSubscriber subscriber,
IResourceContext context)
Remove a subscriber from the configuration.
|
void |
ISynSubscriber.removeSubscription(ISynSubscription subscription,
IResourceContext context)
Remove a subscription from the subscriber.
|
void |
ISynSubscription.resetState(IResourceContext context)
Reset the subscription to intial state.
|
void |
IOffer.setAccess(ICEAccess access,
IResourceContext context)
Set the default access rules of this offer.
|
void |
ISyndicatorConfig.setContentAccessURL(String contentAccessURL,
IResourceContext context)
Set the content access base URL for the subscribers.
|
void |
ISyndicatorConfig.setDefaultLogin(String user,
String password,
IResourceContext context)
Set the login informations of the default user.
|
void |
ISynSubscription.setDeliveryPolicy(ICEDeliveryPolicy deliveryPolicy,
IResourceContext context)
Set/change the negotiated delivery policy for this subscription.
|
void |
IOffer.setDeliveryPolicy(ICEDeliveryPolicy deliveryPolicy,
IResourceContext context)
Set the default delivery policy of this offer.
|
void |
ISynSubscriber.setDescription(String description,
IResourceContext context)
Set the description of the subscriber.
|
void |
IOffer.setDescription(String description,
IResourceContext context)
Set the description of the offer.
|
void |
ISyndicatorConfig.setLocation(URL location,
IResourceContext context)
Set the location of the ICE servlet on this machine.
|
void |
ISynSubscriber.setLoginInfo(String user,
String password,
IResourceContext context)
Set the (default) login informations of the syndicator.
|
void |
ISynSubscriber.setMailFrom(String mailFrom,
IResourceContext context)
Set the reply address of all mails send to the subscriber
|
void |
ISynSubscriber.setMailSubject(String mailSubject,
IResourceContext context)
Set the subject of all mails send to the subscriber
|
void |
ISynSubscriber.setMailTo(String mailTo,
IResourceContext context)
Set the mail address of the subscriber.
|
void |
IOffer.setMaxContentSize(long maxContentSize,
IResourceContext context)
Set the maximal content size of the offer.
|
void |
ISynSubscription.setMaxPackageSize(long maxPackageSize,
IResourceContext context)
Set/change the maximum size of an ICE package created in this subscription.
|
void |
ISynSubscription.setName(String name,
IResourceContext context)
Set the name of the subscription.
|
void |
ISynSubscriber.setName(String name,
IResourceContext context)
Set name of the subscriber.
|
void |
ISyndicatorConfig.setName(String syndicatorName,
IResourceContext context)
Set the name/description of the syndicator.
|
void |
IOfferComponent.setName(String name,
IResourceContext context)
Set the name of the offer part
|
void |
ISynSubscription.setOffer(IOffer offer,
IResourceContext context)
Set/change the subscribted offer.
|
void |
IOfferComponent.setPrefix(String prefix,
IResourceContext context)
Set the prefix that should replace the root uri.
|
void |
IOfferComponent.setRootRID(RID root,
IResourceContext context)
Set the uri of the root collection.
|
void |
ISynSubscriber.setURL(URL url,
IResourceContext context)
Set the URL of the subscriber (ICE servlet).
|
void |
ISynSubscriber.setUUID(UUID uuid,
IResourceContext context)
Set the UUID of the subscriber.
|
void |
ISyndicatorConfig.setUUID(UUID syndicatorUUID,
IResourceContext context)
Set the uuid of the syndicator.
|
void |
ISynSubscriber.setWCMSystem(boolean isWCMSystem,
IResourceContext context)
Mark the subscriber as WCM system.
|
| Modifier and Type | Method and Description |
|---|---|
IRidList |
TestIMSecurityManager.checkRids(IRidList ridList,
IResourceContext context) |
IRidList |
DefaultIMSecurityManager.checkRids(IRidList ridList,
IResourceContext context)
Here you can define your security checker.
|
ITaxonomyTransport |
IIndexService.createTaxonomyTransport()
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
IIndex.deindexDocument(IResource resource)
Removes a document from the index.
|
void |
AbstractIndex.deindexDocument(IResource resource)
Deindexes a document
|
void |
IIndex.deindexDocument(RID rid)
Removes a document from the index.
|
void |
AbstractIndex.deindexDocument(RID resourceRid)
Deindexes a document
|
void |
IIndex.deindexDocument(URI uri)
Deprecated.
as of NW04. Use deindexDocument(RID)
|
void |
AbstractIndex.deindexDocument(URI resourceUri)
Deprecated.
as of NW04. Use deindexDocument(RID)
|
void |
IIndex.deindexDocuments(IResourceList resources)
Removes a list of documents from the index
It is recommended that you do not deindex documents manually using this method. |
void |
AbstractIndex.deindexDocuments(IResourceList resources)
Deindexes a document
|
void |
IIndex.deindexDocuments(IRidList rids)
Removes a list of documents from the index
It is recommended that you do not deindex documents manually using this method. |
void |
AbstractIndex.deindexDocuments(IRidList resourceRids)
Deindexes a document
|
void |
IIndex.deindexDocuments(IUriList uris)
Deprecated.
as of NW04. Use deindex documents(IRidList)
|
void |
AbstractIndex.deindexDocuments(IUriList resourceUris)
Deprecated.
as of NW04. Use deindexDocuments(IRidList)
|
List |
IIndexService.getAllIndexmanagementCrawlers(IIndex index) |
HashSet |
AbstractIndex.getClassProperties() |
static PropertyName |
AbstractIndex.getDisplayNameAsStringPropName() |
static PropertyName |
AbstractIndex.getDocumentFeaturesPropName() |
List |
IIndexService.getFailedCrawlers(IIndex index) |
static Map |
AbstractIndex.getHiddenIndexIds()
only for internal usage
|
List |
IIndexService.getIndexesForResource(IResource resource)
TReturns the indexes into which a document is indexed.
|
static PropertyName |
AbstractIndex.getIndexFolderRidPropName() |
IIndex |
IIndexService.getIndexForResource(IResource resource,
String serviceType)
Returns the index in which the document is indexed depending on the specified service type.
|
AbstractIndex.IndexingState |
AbstractIndex.getIndexingState()
Returns the current state of the index.
|
static PropertyName |
AbstractIndex.getIndexOnlyPropertiesPropName() |
static PropertyName |
AbstractIndex.getLogicalOrPhysicalPropName() |
DefaultQueryExtender |
AbstractIndex.getQueryExtender()
Deprecated.
|
ArrayList<DefaultQueryExtender> |
AbstractIndex.getQueryExtenders() |
String |
IIndex.getResourceInfo(IResource resource)
Returns information about the resource with respect to the actual index
e.g. the status of the document as well as general about the index e.g.
|
DefaultIMSecurityManager |
AbstractIndex.getSecManager()
Only for internal usage
|
void |
IIndex.indexDocument(IResource resource)
Puts a document into the index.
|
void |
AbstractIndex.indexDocument(IResource resource)
Indexes a document
|
void |
IIndex.indexDocument(IResource resource,
IResourceEvent resourceEvent)
Puts a document into the index
It is recommended that you do not index documents manually using this method. |
void |
AbstractIndex.indexDocument(IResource resource,
IResourceEvent resourceEvent)
Indexes a document
|
void |
IIndex.indexDocuments(IResourceList resources)
Puts a list of documents into the index.
|
void |
AbstractIndex.indexDocuments(IResourceList resources)
Indexes a list of documents
|
void |
IIndex.indexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
Puts a list of documents into the index.
|
void |
AbstractIndex.indexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
Indexes a list of documents
|
protected void |
AbstractIndex.internalDeindexDocuments(IRidList rids)
Deindexes documents
|
protected void |
AbstractIndex.internalIndexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
Indexes a list of documents
|
void |
IIndex.setInactiveIndexHasChanged()
Sets a property on true, if index documents have changed during index
was inactive.
|
void |
AbstractIndex.setInactiveIndexHasChanged()
Sets a property on true, if index documents have changed during index
was inactive.
|
void |
AbstractIndex.setIndexingState(AbstractIndex.IndexingState state) |
void |
AbstractIndex.setNumberOfCrawler(int numOfCrawler) |
void |
IIndexService.startXTaxRetrainCrawler(IIndex index,
String taxonomyName,
ICollection taxonomyCollection,
boolean isSearchRelevant)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
IIndexService.updateIndex(IIndex index)
Saves all changes that have been made to the index object.
|
| Constructor and Description |
|---|
Reindexer(boolean disablePostClearTasks) |
ReindexerWithoutClear() |
| Modifier and Type | Method and Description |
|---|---|
IQueryEntryList |
ITaxonomyCollection.buildQueryEntryList() |
IQueryEntryList |
ITaxonomyCollection.buildQueryEntryListForPathOnly() |
IResource |
ITaxonomyTransport.exportDTD(ICollection exportColl) |
IResourceList |
ITaxonomyCollection.getAllDocumentsBelowVirtualTaxNode() |
IResourceList |
ITaxonomyCollection.getChildrenWithAdditionalQuery(IQueryEntryList qList) |
IResourceList |
ITaxonomyCollection.getChildrenWithAdditionalQuery(IQueryEntryList qList,
IRidList searchFromHereList,
Set languages) |
IResourceList |
ITaxonomyCollection.getChildrenWithAdditionalQueryOnlyCollections(IQueryEntryList qList) |
IResourceList |
ITaxonomyCollection.getChildrenWithAdditionalQueryOnlyCollections(IQueryEntryList qList,
IRidList searchFromHereList,
Set languages) |
IRidList |
AbstractClassificationIndex.getClassDocumentRids(ICollection taxonomyClass)
Gets the resource IDs of all documents of a taxonomy class
|
IRidList |
AbstractClassificationIndex.getClassDocumentRids(ICollection taxonomyClass,
List appPropServices)
Gets the resource IDs of all documents of a taxonomy class whereby the parameter appPropServices should
contain the application property service.
|
IResourceList |
IClassificationIndex.getClassDocuments(ICollection taxonomyClass)
Gets all documents of a taxonomy class
The taxonomy class is a folder in the taxonomy repository To get the resource ID of a taxonomy class, first the resource ID of the taxonomy root must be determined by using the getSpecialFolderRID(taxonomyName,SpecialFolder.TAXONOMY) method. |
IResourceList |
AbstractClassificationIndex.getClassDocuments(ICollection taxonomyClass)
Gets all documents of a taxonomy class
|
IResourceList |
AbstractClassificationIndex.getClassDocuments(RID taxonomyClassRid,
IResourceContext context)
Gets all documents of a taxonomy class
|
String |
ICompareTaxonomies.getCompareMessage() |
String |
ITaxonomyCollection.getDisplayNameSuffix() |
String[] |
ITaxonomyCollection.getIndexIds() |
IClassificationIndexCollection |
IClassificationIndex.getNewClassificationIndexCollection()
Returns an index collection where classification operations for multiple
indexes can be performed
|
IPropertyName |
ITaxonomyCollection.getPropertyName() |
String |
ITaxonomyCollection.getQueryDisplayNameforQueryRid() |
IProperty |
ITaxonomyCollection.getRangeFrom() |
IProperty |
ITaxonomyCollection.getRangeTo() |
String |
ITaxonomyCollection.getVirtualTaxDisplayNameDefinition() |
String |
ITaxonomyCollection.getVirtualTaxNodeType() |
void |
IClassificationIndex.indexDocument(IResource resource,
String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
Puts a document into the index
It is recommended that you do not index a document manually using this method. |
void |
AbstractClassificationIndex.indexDocument(IResource resource,
String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
indexes a document (method for internal use)
|
void |
IClassificationIndex.indexDocument(IResource resource,
String taxonomyName,
IUriList taxonomyClasses,
boolean isSearchRelevant)
Deprecated.
as of NW04. Use indexDocument(IResource, String, IRidList, boolean)
|
void |
AbstractClassificationIndex.indexDocument(IResource resource,
String taxonomyName,
IUriList taxonomyClasses,
boolean isSearchRelevant)
Deprecated.
as of NW04. Use indexDocument(IResource, String, IRidList, boolean)
|
void |
AbstractClassificationIndex.indexDocuments(IResourceList resources)
Indexes a list of documents
|
void |
AbstractClassificationIndex.indexDocuments(IResourceList resources,
boolean reindexMode,
boolean sendLinkEvents)
Indexes a list of documents
|
void |
IClassificationIndex.indexDocuments(IResourceList resources,
String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
Indexes a list of documents
It is recommended that you do not index documents manually using this method.
|
void |
AbstractClassificationIndex.indexDocuments(IResourceList resources,
String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
Indexes a list of documents (method for internal use)
|
void |
IClassificationIndex.indexDocuments(IResourceList resources,
String taxonomyName,
IUriList taxonomyClasses,
boolean isSearchRelevant)
Deprecated.
as of NW04. Use indexDocuments(IResourceList, String, IRidList, boolean)
|
void |
AbstractClassificationIndex.indexDocuments(IResourceList resources,
String taxonomyName,
IUriList taxonomyClasses,
boolean isSearchRelevant)
Deprecated.
as of NW04. Use indexDocuments(IResourceList, String, IRidList, boolean)
|
protected void |
AbstractClassificationIndex.internalIndexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
indexes a list of documents (method for internal use)
|
protected abstract void |
AbstractClassificationIndex.internalIndexDocuments(IResourceList resources,
String taxonomyName,
IRidList taxonomyClasses,
IResourceEvent resourceEvent,
boolean isSearchRelevant,
boolean reindexMode,
boolean sendLinkEvents)
Indexes a list of documents (method for internal use)
|
boolean |
ITaxonomyCollection.isVirtualTaxRid() |
| Modifier and Type | Method and Description |
|---|---|
IProperty |
ISearchUtils.createInitialProperty(IPropertyName propName)
Creates a property with initial value for a property name.
|
protected IProperty |
AbstractSearchIndexCollection.createInitialProperty(IPropertyName propName)
Creates a property with initial value for a property name.
|
String |
ISearchResult.getContentSnippet()
Returns the content snippet.
|
ISearchIndexCollection |
ISearchIndex.getNewSearchIndexCollection() |
PropertyType |
ISearchUtils.getPropertyType(IPropertyName propName)
Determines the property type using the property config service.
|
protected PropertyType |
AbstractSearchIndexCollection.getPropertyType(IPropertyName propName)
Determines the property type using the property config service.
|
ISearchResultList |
IRawSearchSession.getSearchResults(List rawSearchResults)
Converts raw search results in real search results
|
ISearchResultList |
ISearchIndexCollection.getSearchResults(List rawSearchResults,
IResourceContext context) |
abstract ISearchResultList |
AbstractSearchIndexCollection.getSearchResults(List rawSearchResults,
IResourceContext context) |
void |
ISearchResult.setContentSnippet(String contentSnippet)
Sets the content snippet.
|
| Modifier and Type | Method and Description |
|---|---|
static IPropertyNameList |
VTInitializer.testPropertyNameList() |
| Modifier and Type | Method and Description |
|---|---|
IResource |
IRelationOperand.asResource()
Get the relation operand as resource, if this operand is managed by a
repository manager.
|
boolean |
IRelationOperandType.check(IRelationOperand operand)
Check, if a given operand belongs to this type.
|
IRelationTypeAttributes |
IRelationService.checkRelationTypeAttributes(IRelationTypeAttributes attributes,
IRelationOperandType sourceType,
IRelationOperandType targetType)
Get a checked set of attributes which are compatible with the given source
and target operand types and can be use to created a
IRelationType
. |
IRelation |
IRelationType.createRelation(IOrderedRelationPosition position,
IRelationOperand source,
IRelationOperand target)
a shortcut for
createRelation(source,
target, null). |
IRelation |
IRelationType.createRelation(IOrderedRelationPosition position,
IRelationOperand source,
IRelationOperand target,
IPropertyMap properties)
Create a new ordered relation from wrapped operands.
|
IRelation |
IRelationType.createRelation(IOrderedRelationPosition position,
Object source,
Object target)
a shortcut for
createRelation(source, target, null). |
IRelation |
IRelationType.createRelation(IOrderedRelationPosition position,
Object source,
Object target,
IPropertyMap properties)
Create a ordered relation from operand values.
|
IRelation |
IRelationType.createRelation(IRelationOperand source,
IRelationOperand target)
a shortcut for
createRelation(source, target, null). |
IRelation |
IRelationType.createRelation(IRelationOperand source,
IRelationOperand target,
IPropertyMap properties)
Create a new relation from wrapped operands.
|
IRelation |
IRelationType.createRelation(Object source,
Object target)
a shortcut for
createRelation(source, target, null). |
IRelation |
IRelationType.createRelation(Object source,
Object target,
IPropertyMap properties)
Create a relation from operand values.
|
IRelationType |
IRelationService.createRelationType(IResourceContext context,
String namespace,
String name,
Descriptions descriptions,
IRelationOperandType sourceType,
IRelationOperandType targetType)
Create a new relation type for a given namespace and name if it does not
already exist.
|
IRelationType |
IRelationService.createRelationType(IResourceContext context,
String namespace,
String name,
Descriptions descriptions,
IRelationOperandType sourceType,
IRelationOperandType targetType,
IRelationTypeAttributes attributes)
Create a new relation type for a given namespace, name and set of
attributes if it does not already exist.
|
IRelationType |
IRelationService.createResourceRelationType(IResourceContext context,
String namespace,
String name,
Descriptions descriptions,
IRelationTypeAttributes attributes)
Convenience method to create a relation type for resources as source and
target.
|
IRelationType |
IRelationService.createStringRelationType(IResourceContext context,
String namespace,
String name,
Descriptions descriptions,
IRelationTypeAttributes attributes)
Convenience method to create a relation type for resources as source and
strings as target.
|
void |
IRelationType.delete()
Deregister this relation type and delete all of it's relations.
|
void |
IRelation.delete()
Delete a given relation.
|
void |
IRelation.deleteProperties(IPropertyNameList propertyNameList)
Delete several specified properties (if they exist).
|
void |
IRelation.deleteProperty(IPropertyName propertyName)
Delete a specific property.
|
String |
IRelationOperand.getID()
Get the relation operand's unique id.
|
static IRelationService |
RelationServiceFactory.getInstance()
Get instance of the service of this package.
|
IRelationOperand |
IRelationOperandType.getOperand(Object object)
Create the proper operand for a given object, if it belongs to this type.
|
IRelationOperand |
IRelationOperandType.getOperand(String id,
IResourceContext context)
Get the operand for a given id and context.
|
IOrderedRelationPosition |
IRelation.getPosition()
Get the relation's positioning.
|
IPropertyMap |
IRelation.getProperties()
Get all properties of the relation.
|
IPropertyMap |
IRelation.getProperties(IPropertyNameList propertyNameList)
Get several specified properties.
|
IProperty |
IRelation.getProperty(IPropertyName propertyName)
Get a specific property.
|
IRelationQueryBuilder |
IRelationService.getQueryBuilder()
Get a query builder to build search query expressions and order expressions
for retrieving relations.
|
IRelation |
IRelationType.getRelation(IRelationOperand source,
IRelationOperand target)
Get the relation for a given wrapped source and target.
|
IRelation |
IRelationType.getRelation(Object source,
Object target)
Get the relation for a given source and target value.
|
IRelation |
IRelationType.getRelation(String id)
Get a specific relation for a given type and id.
|
IRelation |
IRelationOperand.getRelationBySource(IRelationType type,
IRelationOperand target)
same as
type.getRelation(this, target); |
IRelation |
IRelationOperand.getRelationByTarget(IRelationType type,
IRelationOperand source)
same as
type.getRelation(source, this); |
IRelationList |
IRelationService.getRelationList()
Get an empty list for relations.
|
IOrderedRelationPositioningList |
IRelationService.getRelationPositioningList()
Get an empty list for reordering.
|
IRelationList |
IRelationType.getRelations()
Get all availabe relations for this type.
|
IRelationList |
IRelationType.getRelations(IRelationOperand source)
Deprecated.
as of NW04. Please use getRelationsBySource instead Get all the relations
of this type for the given source operand.
|
IRelationList |
IRelationType.getRelations(IRelationQuery query)
Get the relations for this type, which match a given query expression.
|
IRelationList |
IRelationType.getRelations(IRelationQuery query,
IRelationQueryOrder order)
Get the relations for this type, which match a given query expression.
|
IRelationList |
IRelationService.getRelations(IResourceContext context,
IRelationOperand source,
IRelationOperand target)
Get all relations of any type for the given source and target.
|
IRelationList |
IRelationService.getRelations(IResourceContext context,
IRelationQuery query)
Get the relations which match a given query expression.
|
IRelationList |
IRelationService.getRelations(IResourceContext context,
IRelationQuery query,
IRelationQueryOrder order)
Get the relations which match a given query expression, ordered by a given
order expression.
|
IRelationList |
IRelationType.getRelations(Object source)
Deprecated.
as of NW04. Please use gteRelationsBySource instead Get all the relations
of this type for the given source operand value.
|
IRelationList |
IRelationType.getRelationsBySource(IRelationOperand source)
Get all the relations of this type for the given source operand.
|
IRelationList |
IRelationOperand.getRelationsBySource(IRelationType type)
same as
type.getRelationBySource(this); |
IRelationList |
IRelationOperand.getRelationsBySource(IResourceContext context)
same as
IRelationService.getRelationsBySource(context, this); |
IRelationList |
IRelationService.getRelationsBySource(IResourceContext context,
IRelationOperand source)
Get all relations of any type for the given source.
|
IRelationList |
IRelationOperand.getRelationsBySource(IResourceContext context,
IRelationOperand target)
same as
IRelationService.getRelations(context, this, target); |
IRelationList |
IRelationType.getRelationsBySource(Object source)
Get all the relations of this type for the given source operand value.
|
IRelationList |
IRelationType.getRelationsByTarget(IRelationOperand target)
Get all the relations of this type for the given target operand.
|
IRelationList |
IRelationOperand.getRelationsByTarget(IRelationType type)
same as
type.getRelationByTarget(this); |
IRelationList |
IRelationOperand.getRelationsByTarget(IResourceContext context)
same as
IRelationService.getRelationsByTarget(context, this); |
IRelationList |
IRelationService.getRelationsByTarget(IResourceContext context,
IRelationOperand target)
Get all relations of any type for the given target.
|
IRelationList |
IRelationOperand.getRelationsByTarget(IResourceContext context,
IRelationOperand source)
same as
IRelationService.getRelations(source, this); |
IRelationList |
IRelationType.getRelationsByTarget(Object target)
Get all the relations of this type for the given target operand value.
|
IRelationType |
IRelationService.getRelationType(IResourceContext context,
String namespace,
String name)
Get a specific relation type for a given namespace and name.
|
IRelationTypeAttributes |
IRelationService.getRelationTypeAttributes(IRelationTypeHandler typeHandler,
IPropertyNameList requiredProperties,
boolean oneToOne,
boolean ordered,
boolean sourceDeleteTracking,
boolean targetDeleteTracking,
boolean sourceChangeTracking,
boolean targetChangeTracking)
Same as
IRelationService.getRelationTypeAttributes(IRelationTypeHandler,
IPropertyNameList, boolean, boolean, boolean, boolean, boolean, boolean,
boolean, boolean) with sourceCopyTracking and
targetCopyTracking set to false |
IRelationTypeAttributes |
IRelationService.getRelationTypeAttributes(IRelationTypeHandler typeHandler,
IPropertyNameList requiredProperties,
boolean oneToOne,
boolean ordered,
boolean sourceDeleteTracking,
boolean targetDeleteTracking,
boolean sourceChangeTracking,
boolean targetChangeTracking,
boolean sourceCopyTracking,
boolean targetCopyTracking)
Get a set of unchecked attributes which can be use to created a
IRelationType . |
IRelationTypeHandler |
IRelationService.getRelationTypeHandler(String id)
Get a type handler for a relation type (which defines 'workarea' for a
relation type, like caches and tablespaces).
|
IRelationTypeList |
IRelationService.getRelationTypeList()
Get an empty list for relation types.
|
IRelationTypeList |
IRelationService.getRelationTypes(IResourceContext context)
Get a list of all relation types which are available within the given
context.
|
IRelationTypeList |
IRelationService.getRelationTypes(IResourceContext context,
String namespace)
Get a list of all relation types of the given namespace which are available
within the given context.
|
IRelationOperand |
IRelation.getSource()
Get the relation's source operand.
|
Object |
IRelation.getSourceOperand()
Get the relation's source operand's value.
|
IRelationOperand |
IRelation.getTarget()
Get the relation's target operand.
|
Object |
IRelation.getTargetOperand()
Get the relation's target operand's value.
|
IRelationOperandType |
IRelationOperand.getType()
Get the relation operand's type.
|
void |
IRelationType.reorder(IOrderedRelationPositioningList ordering)
Reorder the relations for this type.
|
IRelationTypeAttributes |
IRelationType.setAttributes(IRelationTypeAttributes attributes)
Change the effective attributes of this relation type.
|
void |
IRelation.setPosition(IOrderedRelationPosition position)
Change the relation's position (only supported for
IOrderedRelation
s). |
void |
IRelation.setProperties(IPropertyMap properties)
Set several specified properties.
|
void |
IRelation.setProperty(IProperty property)
Set a specific property.
|
IRelation |
IRelation.setSource(IRelationOperand source)
Set the relation's source operand.
|
IRelation |
IRelation.setSourceOperand(Object source)
Set the relation's source operand by value.
|
IRelation |
IRelation.setTarget(IRelationOperand target)
Set the relation's target operand.
|
IRelation |
IRelation.setTargetOperand(Object target)
Set the relation's target operand value.
|
void |
IRelationType.startWatching(IRelationWatcher watcher)
Register a watcher to this relation type.
|
void |
IRelationType.stopWatching(IRelationWatcher watcher)
Deregister a watcher from this relation type.
|
| Modifier and Type | Method and Description |
|---|---|
IResource |
StringOperand.asResource() |
IResource |
ResourceOperand.asResource() |
abstract IResource |
AbstractRelationOperand.asResource() |
boolean |
StringOperandType.check(IRelationOperand operand) |
boolean |
ResourceOperandType.check(IRelationOperand operand) |
String |
StringOperand.getID() |
String |
ResourceOperand.getID() |
abstract String |
AbstractRelationOperand.getID() |
IResource |
ResourceOperand.getLinkValue()
If the wrapped resource is an internal link, return the target of the link
(following several links). if it's not a internal link just return the
resource.
|
IRelationOperand |
ResourceOperandType.getOperand(String id,
IResourceContext context) |
IRelationOperandExtended |
IRelationOperandTypeExtended.getOperand(String id,
IResourceContext context,
Properties properties)
Get the operand for a given id, context and the stored properties from the
relation manager.
|
Properties |
IRelationOperandExtended.getOperandProperties()
Get the properties to store for this relation operand.
|
IRelation |
AbstractRelationOperand.getRelationBySource(IRelationType type,
IRelationOperand target) |
IRelation |
AbstractRelationOperand.getRelationByTarget(IRelationType type,
IRelationOperand source) |
IRelationList |
AbstractRelationOperand.getRelationsBySource(IRelationType type) |
IRelationList |
AbstractRelationOperand.getRelationsBySource(IResourceContext context) |
IRelationList |
AbstractRelationOperand.getRelationsBySource(IResourceContext context,
IRelationOperand target) |
IRelationList |
AbstractRelationOperand.getRelationsByTarget(IRelationType type) |
IRelationList |
AbstractRelationOperand.getRelationsByTarget(IResourceContext context) |
IRelationList |
AbstractRelationOperand.getRelationsByTarget(IResourceContext context,
IRelationOperand source) |
IRelationOperandType |
StringOperand.getType() |
IRelationOperandType |
ResourceOperand.getType() |
abstract IRelationOperandType |
AbstractRelationOperand.getType() |
| Constructor and Description |
|---|
ResourceOperandType(IResource resource)
Create a resource operand type for a given resource's type.
|
ResourceOperandType(String type)
Create a resource operand type for a specific resource type.
|
| Modifier and Type | Method and Description |
|---|---|
IReportResult |
IResultReceiver.abort(String description,
List propertyNames)
Abort reporting results and retrieve IReportResult object
representing all collected, incomplete results and errors.
|
IReportResult |
IResultReceiver.abort(String description,
List propertyNames,
List summaryProps)
Abort reporting results and retrieve IReportResult object
representing all collected, incomplete results and errors.
|
void |
IResultReceiver.addError(RID rid,
String description,
Throwable ex)
Add an error to the collected report results.
|
void |
IResultReceiver.addItem(IResultItem item)
Adds an item to the collected report results.
|
IReportResult |
FolderSizeCalculation.calculate(IResultReceiver receiver,
boolean showResult,
List scope,
boolean setPropertyTop,
boolean setProperty,
String propNameSize,
String propNameDate,
String propNamespace,
boolean includeVersions,
boolean includeHidden)
Method to be called by Folder Size Calculation Report.
|
long |
FolderSizeCalculation.calculate(List scope,
boolean setPropertyTop,
boolean setProperty,
String propNameSize,
String propNameDate,
String propNamespace,
boolean includeVersions,
boolean includeHidden)
Calculates the folder size for each folder
|
IReportResult |
IReportStore.create(IReportResult rr,
IResourceContext context)
Create a new resource representing the given report result.
|
IScheduledReport |
ScheduledReport.create(IResourceContext context) |
IScheduledReport |
IScheduledReport.create(IResourceContext context)
Persist the scheduled report as a new resource and return a scheduled report instance
where getResource() returns the resource the scheduled report was persisted in.
|
IScheduledReport |
IReportStore.create(IScheduledReport sr,
IResourceContext context)
Create a new resource representing the given scheduled report.
|
IScheduledReport |
IReportingService.create(IScheduledReport sr,
IResourceContext context)
Create a scheduled report at a new storage location.
|
IReportResult |
IReport.execute(IReportInput input,
IResourceContext context,
IResultReceiver receiver)
Execute a
IReportInput immediately in the given context. |
IReportResult |
IReport.execute(IRIDIterator iter,
IReportInput input,
IResourceContext context,
IResultReceiver receiver)
Execute a
IReport on a number of resources. |
IReportResult |
IResultReceiver.finish(String description,
List propertyNames)
Finish reporting results and retrieve IReportResult object
representing all collected results and errors.
|
IReportResult |
IResultReceiver.finish(String description,
List propertyNames,
List summaryProps)
Finish reporting results and retrieve IReportResult object
representing all collected results and errors.
|
RID |
IReportingService.getActiveSchedulesCollection()
Get RID of collection containing active scheduled reports.
|
List |
IReport.getApplicableCommands(IReportResult result)
Retrieves the list of
IReportCommands which are applicable to
the given report result. |
RID |
IScopeController.getBrowseLocation()
In case this controller has scope mode SCOPE_MODE_ANY, returns the best
starting location for browsing resources.
|
IReportCommand |
IReport.getCommand(IName name)
Return a specific report command by name which belongs to this report.
|
List |
IReport.getCommands()
Return the list of all commands belonging to this report.
|
IReportInput |
IReportFollowup.getFollowupInput(IName report,
IReportResult result,
IResultIterator selected)
Calculate an appropriate
IReportInput useable for executing the
given IReport as follow-up on the given IReportResult. |
List |
IReportFollowup.getFollowupReports(IReportResult result)
|
IReportInput |
IRunningReport.getInput()
Get input for running report
|
IReportInput |
IReportResult.getInput()
Get input data used for the generation of this result
|
IResultItem |
IReportResult.getItem(int index)
Retrieve index-th result item.
|
List |
IReportResult.getItems(int offset,
int length)
Returns a list of result items, starting at given offset with given
maximum length.
|
IRIDIterator |
IRunningReport.getIterator()
Get iterator of RIDs where report should be applied or
null if
set of RIDs is not defined. |
IReportInputMeta |
IReportCommand.getMeta()
Get meta information about input to this command
|
IReportInputMeta |
IReport.getMeta()
Get meta information about input to this report.
|
IReport |
IReportingService.getReport(IName name,
IResourceContext context)
Lookup a report by name.
|
IReport |
IReportCollection.getReport(IName name,
IResourceContext context)
Return IReport with given name or
null if not found. |
IName |
IReportResult.getReportName()
Returns the name of the report which produced this result
|
IReportResult |
IReportingService.getReportResult(IResource resource)
Convert a resource to a
IReportResult. |
RID |
IReportCollection.getReportRID(IName name)
Return RID of report resource with given name or
null if not found. |
Set |
IReportingService.getReports(IResourceContext context)
Get the set of all known
IReports. |
RID |
IReportingService.getReportsCollection()
Get RID of collection containing reports.
|
Set |
IReportCollection.getReportSet(IResourceContext context)
Return set of available IReports.
|
IResource |
IRunningReport.getResource()
Get the resource, if it does exist, which represent this running report.
|
IResource |
IReportResult.getResource()
Returns an IResource this result is persisted in, if at all.
|
IResource |
IReportingService.getResource(IReport report,
IResourceContext context)
Get the resource representing the report
|
List |
IReportResult.getResultPropertyNames()
Returns the list of property names which are set for each result item.
|
int |
IReportResult.getResultSize()
Get number of individual items reported.
|
IRunningReport |
IRunningReportCollection.getRunningReport(String id,
IResourceContext context)
Get
IRunningReport for given id. |
IRunningReport |
IReportingService.getRunningReport(String id,
IResourceContext context)
Get running report with given id.
|
List |
IRunningReportCollection.getRunningReports(IResourceContext context)
Get the list of all running reports.
|
List |
IReportingService.getRunningReports(IResourceContext context)
Get the list of all currently running reports.
|
RID |
IReportingService.getRunningReportsCollection()
Get RID of collection displaying running reports.
|
IScheduledReport |
IReportingService.getScheduledReport(IResource resource)
Convert a resource to a
IScheduledReport. |
Set |
IReportStore.getScheduledReports(IResourceContext context)
Return the set of scheduled reports.
|
Set |
IReportCollection.getSchedulesDue()
Get set of
IScheduledReports which are due for execution. |
List |
IScopeController.getScopeList()
In case this controller has scope mode SCOPE_MODE_LIST, returns the list
of available scopes as list of
IScopeController.IScopeEntrys. |
static IReportingService |
Reports.getService()
Get reporting service
|
Date |
IRunningReport.getStartedAt()
Get date report was started
|
List |
IReportResult.getSummaryProperties()
Returns the list of
IPropertys which give a summary of the
report execution. |
boolean |
ReportResultIterator.hasNext() |
boolean |
IRIDIterator.hasNext() |
boolean |
IResultIterator.hasNext()
Returns true if the iterator has more elements.
|
boolean |
IRunningReport.isFinished()
Return if report is finished
|
IResultIterator |
IReportResult.iterator()
Get iterator over all individual
IResultItems |
IResource |
IReportStore.linkTo(IResource target)
Create a new flex link which points to the given resource.
|
IResultItem |
ReportResultIterator.next() |
RID |
IRIDIterator.next() |
IResultItem |
IResultIterator.next()
Return the next element.
|
RID |
IReportingService.registerIDMapping(IName name)
Reserves a unique and persistent namespace prefix for the given name.
|
RID |
IReportCollection.registerIDMapping(IName name,
IResourceContext context)
Reserves a unique and persistent namespace prefix for the given name.
|
IRunningReport |
IReportingService.run(String name,
IReportInput input,
IResourceContext context)
Run a
IReportInput immediately in the given context. |
IRunningReport |
IReportingService.run(String name,
IReportInput input,
IRIDIterator iter,
IResourceContext context)
Run a
IReportInput immediately in the given context. |
IResource |
IRunningReportCollection.start(String name,
Date started,
IReportInput input,
IResourceContext context)
Start a new running report with given parameters.
|
IResource |
IRunningReportCollection.start(String name,
Date started,
IReportInput input,
IRIDIterator iter,
IResourceContext context)
Start a new running report with given parameters.
|
long |
IReportResult.took()
Get execution time of the report (milliseconds)
|
IReportResult |
IReportStore.update(IReportResult rr,
IResource resource)
Update the given resource with the report result.
|
IReportResult |
IReportingService.update(IReportResult result,
IResourceContext context)
Persist a report result at the default storage location.
|
IScheduledReport |
ScheduledReport.update(IResource resource) |
IScheduledReport |
IScheduledReport.update(IResource resource)
Persist the scheduled report and return a scheduled report instance
where getResource() returns the resource the scheduled report was persisted in.
|
IScheduledReport |
IReportStore.update(IScheduledReport sr,
IResource resource)
Update the given resource with the scheduled report.
|
IScheduledReport |
IReportingService.update(IScheduledReport sr,
IResource resource)
Persist a scheduled report at the resource.
|
IReportInputError |
IReport.verify(IReportInput input,
IResourceContext context)
Verify that input is valid for this report.
|
IReportInputError |
ReportInput.verify(IResourceContext context) |
IReportInputError |
IReportInput.verify(IResourceContext context)
Verify that input is valid.
|
Date |
IReportResult.wasExecuted()
Get date the report was executed
|
| Modifier and Type | Method and Description |
|---|---|
void |
IResourceObserver.endCollection(ICollection col)
Invoked when traversal of a collection was finished.
|
void |
IResourceObserver.observe(IResource resource)
Invoked when a resource is to be inspected.
|
void |
IResourceObserver.observeError(RID rid,
String message,
Throwable t) |
boolean |
IResourceObserver.startCollection(ICollection col)
Invoked before a collection is entered.
|
void |
RidWalker.walk() |
void |
IWalker.walk() |
void |
HierarchyWalker.walk() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
IResourceFilter.isFiltered(IResource resource)
Check if a resource matches the filter specifications (scope and result).
|
boolean |
IResourceFilter.isFiltered(IResource resource,
long maxRetrievalTimeInMilliseconds) |
boolean |
IResourceFilter.isFilteredByResult(IResource resource)
Check if a resource matches the filter specifications that are designated as result filters.
|
boolean |
IResourceFilter.isFilteredByResult(IResource resource,
long maxRetrievalTimeInMilliseconds) |
boolean |
IResourceFilter.isFilteredByScope(RID rid)
Check if a resource matches the filter specifications that are designated as scope filters.
|
| Modifier and Type | Method and Description |
|---|---|
static IResourceTypeRegistryService |
ResourceTypeRegistryServiceFactory.getInstance()
Get instance of the service of this package.
|
| Modifier and Type | Method and Description |
|---|---|
RID |
IUserManagementRidGenerator.getUserResourceRid(String userId,
String mimetype) |
String |
IURLGenerator.replaceURIPlaceholders(String uri,
IResource resource)
Deprecated.
Replaces placeholders in URI
|
String |
IURLGenerator.replaceURIPlaceholders(String uri,
IResourceContext context)
Deprecated.
Replaces placeholders in URI
|
String |
IPlaceholderResolver.resolvePlaceholder(String str,
IResourceContext context)
Replaces all occurrences of placeholder in
str by the
corresponding value. |
String |
IURLGeneratorService.resolvePlaceholders(String uri,
IResource resource)
Resolves all placeholders contained in
uri by their
corresponding values. |
String |
IURLGeneratorService.resolvePlaceholders(String uri,
IResourceContext context)
Resolves all placeholders contained in
uri by their
corresponding values. |
String |
IURLGeneratorService.resolveRidPlaceholders(String rid,
IResourceContext context)
Resolves all placeholders contained in
rid by their
corresponding values. |
| Modifier and Type | Method and Description |
|---|---|
IWebDAVSite |
IWebDAVSiteController.add(IWebDAVSite site,
boolean replaceExisting)
Add a new site with the given settings.
|
IWebDAVSite |
IWebDAVSiteController.get(String name)
Get the
IWebDAVSite for the given name. |
IWebDAVSite[] |
IWebDAVSiteController.getSites()
Get all sites managed by this controller.
|
void |
IWebDAVSiteController.remove(String name)
Remove a site of given name.
|
IWebDAVSite |
IWebDAVSiteController.update(IWebDAVSite site)
Update a site with the settings from the given object.
|
| Modifier and Type | Method and Description |
|---|---|
IResourceAcl |
AclPrinter.getAcl(IResource resource)
Returns the (direct) ACL of a resource or null if no ACL is assigned for this resource.
|
Copyright 2021 SAP SE Complete Copyright Notice