|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Not Implemented in CS Java Connector v3.0.
ASubscription
object identifies the request to receive notification
upon the occurrence of one or more types of events and defines the event action
to be performed in response to the triggered events.
To create a Subscription
object and persist it to a Content
Services object store,
call the ObjectStore
interface's
createObject
method. An appropriate
EventAction
object must exist before you can create a Subscription
object and persist it.
You can instantiate a persisted Subscription
object in the following ways:
getObject
method on an
ObjectStore
object.
Subscriptions
collection, then
returning a Subscription
object from the collection. See
the
Subscriptions
interface for ways to instantiate a Subscriptions
collection.
Field Summary |
Method Summary | |
void |
delete()
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getPermissionsXML()
Not Implemented in CS Java Connector v3.0. |
Permissions |
getUserAccess()
Not Implemented in CS Java Connector v3.0. |
Permissions |
getUserAccess(java.lang.String collectionType)
Not Implemented in CS Java Connector v3.0. |
Permissions |
getUserAccess(java.lang.String collectionType,
java.lang.String userId)
Not Implemented in CS Java Connector v3.0. |
Methods inherited from interface com.filenet.wcm.api.BaseObject |
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject |
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject |
setPermissions, setPermissions |
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject |
setProperties |
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject |
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh |
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject |
getPermissions, getPermissions |
Method Detail |
public void delete()
Not Implemented in CS Java Connector v3.0.
Deletes thisSubscription
object. After a successful call to
delete
, all properties are considered stale and are removed
from cache for this Subscription
object.
public java.lang.String getPermissionsXML()
Not Implemented in CS Java Connector v3.0.
Retrieves a string in XML that represents the permissions for thisSubscription
object. The user must have Read permission on the
object's security (either Permission.LEVEL_VIEW or Permission.RIGHT_READ_ACL)
to retrieve the object's permissions. Note that the returned string
represents basic object permissions (i.e., an object's Permissions property).
Subscription
object.
For documentation that describes the XML schema used to generate
the string, refer to
Schemas
in the FileNet P8 Developer's Roadmap.
public Permissions getUserAccess()
Not Implemented in CS Java Connector v3.0.
Retrieves the access rights (permissions) for the current user on thisSubscription
object. (The current user is
identified in the Session
object.) The elements
in the returned collection are the access rights assigned to the current
user and to any groups to which this user belongs. If the user does not
have explicit rights, this method returns only the access rights of the
groups to which the user belongs.
Note that the returned Permissions
collection represents
basic object permissions (i.e., an object's Permissions property). To
specify the type of permissions (basic object or audit) to retrieve for
the current user, use
getUserAccess(collectionType)
.
Permissions
collection containing the access rights
for the current user on this Subscription
object.
public Permissions getUserAccess(java.lang.String collectionType)
Not Implemented in CS Java Connector v3.0.
Retrieves the access rights (permissions) of the specified type for the current user on thisSubscription
object. (The current user is
identified in the Session
object.) The elements in the returned collection are the access rights
assigned to the current user and to any groups to which this user belongs.
If the user does not have explicit rights, this method returns only the
access rights of the groups to which the user belongs.
Specify the type of permissions (basic object or audit)
to return in the collectionType
parameter.
If the user is not an Administrator and does not have specific
privileges to access audit permissions, this method throws an
InsufficientPermissionException if the specified collection type is
Property.AUDIT_PERMISSIONS
. This exception occurs even if the user
has been granted full control access rights (Permission.LEVEL_FULL_CONTROL
)
to the object. To set audit permissions privileges for the user, refer to the
Enable security auditing
topic.
collectionType
- A String that is the name of a property whose value is a
collection of Content Services Permission objects.
Use Property.PERMISSIONS
for basic object
permissions or Property.AUDIT_PERMISSIONS
for audit permissions.
Permissions
collection of the specified type containing the
access rights for
the current user on this
Subscription
object.
public Permissions getUserAccess(java.lang.String collectionType, java.lang.String userId)
Not Implemented in CS Java Connector v3.0.
Retrieves the access rights (permissions) of the specified type for the specified user on thisSubscription
object.
The elements in the returned collection are the access rights
assigned to the specified user and to any groups to which this user belongs.
If the user does not have explicit rights, this method returns only the
access rights of the groups to which the user belongs.
Specify the type of permissions to return in the collectionType
parameter.
Currently, the only valid value for collectionType
is the
Property.PERMISSIONS
constant for
basic object permissions
(that is, an object's Permissions property).
getUserAccess()
or
getUserAccess(collectionType)
.
These two methods offer equivalent functionality.
collectionType
- A String that is the name of a property whose value is a
collection of Content Services Permission
objects.
Currently, the only valid value is Property.PERMISSIONS
(for basic object permissions). This method throws a
RemoteServerException if you specify any other value.
userId
- A String (whose value is a User object's Name property) that
identifies the user for whom permissions are to be retrieved.
Permissions
collection of the specified type
containing the access rights for the specified user on this
Subscription
object.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |