Skip navigation links

oracle.webcenter.doclib.view
Interface DocumentsServiceBean

public interface DocumentsServiceBean

Managed bean used to provide information from the documents service. This bean is EL accessible as #{documentsService}.

Since:

11.1.1.4.0

Method Summary

java.util.List<RepositoryInfo>	getConnectionsList() Gets a list of available content repository connections
GroupSpaceDocumentsInfo	getCurrentGroupSpace() Provides information on the current group space documents. Available in WebCenter Spaces only. EL: #{documentsService.currentGroupSpace}
PersonalSpaceDocumentsInfo	getCurrentUser() Provides information on the current user's documents. Available in WebCenter Spaces only. EL: #{documentsService.currentUser}
java.lang.String	getDefaultConnectionName() Gets the default content repository connection name.
java.util.Map<java.lang.String,GroupSpaceDocumentsInfo>	getGroupSpaceByGUID() Provides a way to lookup group space documents information by group space GUID. Available in WebCenter Spaces only. EL: #{documentsService.groupSpaceByGUID['s5dd6d6b3_7f5f_4f1c_8ee6_ce305469f1b3']}
java.util.Map<java.lang.String,GroupSpaceDocumentsInfo>	getGroupSpaceByName() Provides a way to lookup group space documents information by group space name. Available in WebCenter Spaces only. EL: #{documentsService.groupSpaceByName['myGS']}
java.util.Map<java.lang.String,java.lang.String>	getLatestReleasedVersionURL() Provides a Map that can be used to retrieve the latest released version URL for a content item.
java.util.Map<java.lang.String,java.lang.String>	getLatestVersionURL() Provides a Map that can be used to retrieve the latest version URL for a content item.
java.util.Map<java.lang.String,java.lang.String>	getSpecificVersionURL() Provides a Map that can be used to retrieve the URL for a specific version of a content item.
java.util.Map<java.lang.String,java.lang.String>	getURL() Provides a Map that can be used to retrieve the default URL for a content item.
java.util.Map<java.lang.String,PersonalSpaceDocumentsInfo>	getUserByName() Provides a way to lookup user documents information by user name GUID. Available in WebCenter Spaces only. EL: #{documentsService.userByName['weblogic']}
boolean	isConfigured() Checks whether the Documents Service is configured EL: #{documentsService.configured}

Method Detail

getDefaultConnectionName

java.lang.String getDefaultConnectionName()

Gets the default content repository connection name.
EL: #{documentsService.defaultConnectionName}

Returns:

The default connection name, or null if no default connection is defined.

getConnectionsList

java.util.List<RepositoryInfo> getConnectionsList()

Gets a list of available content repository connections

Returns:

The list of available content repository connections

isConfigured

boolean isConfigured()

Checks whether the Documents Service is configured
EL: #{documentsService.configured}

Returns:

true if the Documents Service is configured, otherwise false.

getCurrentGroupSpace

GroupSpaceDocumentsInfo getCurrentGroupSpace()

Provides information on the current group space documents.
Available in WebCenter Spaces only.
EL: #{documentsService.currentGroupSpace}

Returns:

a bean providing access to documents related information for the group space

getGroupSpaceByName

java.util.Map<java.lang.String,GroupSpaceDocumentsInfo> getGroupSpaceByName()

Provides a way to lookup group space documents information by group space name.
Available in WebCenter Spaces only.
EL: #{documentsService.groupSpaceByName['myGS']}

Returns:

a bean providing access to documents related information for the group space

getGroupSpaceByGUID

java.util.Map<java.lang.String,GroupSpaceDocumentsInfo> getGroupSpaceByGUID()

Provides a way to lookup group space documents information by group space GUID.
Available in WebCenter Spaces only.
EL: #{documentsService.groupSpaceByGUID['s5dd6d6b3_7f5f_4f1c_8ee6_ce305469f1b3']}

Returns:

a bean providing access to documents related information for the group space

getCurrentUser

PersonalSpaceDocumentsInfo getCurrentUser()

Provides information on the current user's documents.
Available in WebCenter Spaces only.
EL: #{documentsService.currentUser}

Returns:

a bean providing access to documents related information for the user

getUserByName

java.util.Map<java.lang.String,PersonalSpaceDocumentsInfo> getUserByName()

Provides a way to lookup user documents information by user name GUID.
Available in WebCenter Spaces only.
EL: #{documentsService.userByName['weblogic']}

Returns:

a bean providing access to documents related information for the user

getLatestReleasedVersionURL

java.util.Map<java.lang.String,java.lang.String> getLatestReleasedVersionURL()

Provides a Map that can be used to retrieve the latest released version URL for a content item.

This is only meaningful for an Oracle Content Server. For other servers, the default URL is returned.

The map is keyed on the serialized JCRContentID for a content item. This content ID must specify either a path or a FILE_UUID. A version UUID is not supported.

The URL is generated at map lookup time.

Returns:

a map to retrieve the latest released version url for a content item identified by a serialized JCRContentID

getLatestVersionURL

java.util.Map<java.lang.String,java.lang.String> getLatestVersionURL()

Provides a Map that can be used to retrieve the latest version URL for a content item.

This is only meaningful for an Oracle Content Server. For other servers, the default URL is returned.

The map is keyed on the serialized JCRContentID for a content item, prefixed by 'U' or 'N' to indicate if the item is from a UCM repository or not.

This content ID must specify either a path or a file UUID. A version UUID is not supported.

The URL is generated at map lookup time.

Returns:

a map to retrieve the latest version url for a content item identified by a serialized JCRContentID.

getSpecificVersionURL

java.util.Map<java.lang.String,java.lang.String> getSpecificVersionURL()

Provides a Map that can be used to retrieve the URL for a specific version of a content item.

This is only meaningful for an Oracle Content Server. For other servers, the default URL is returned.

The map is keyed on the serialized JCRContentID for a content item, prefixed by 'U' or 'N' to indicate if the item is from a UCM repository or not.

For an Oracle Content Server, this JCRContentID must specify a UUID which is a version UUID.

The URL is generated at map lookup time.

Returns:

a map to retrieve the url for a specific version of a content item, as identified by a serialized JCRContentID.

getURL

java.util.Map<java.lang.String,java.lang.String> getURL()

Provides a Map that can be used to retrieve the default URL for a content item.

The map is keyed on the serialized JCRContentID for a content item, prefixed by 'U' or 'N' to indicate if the item is from a UCM repository or not.

The URL is generated at map lookup time.

Returns:

a map to retrieve the url for a content item identified by a serialized JCRContentID.

Skip navigation links