Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface UserSubscription

All Superinterfaces:
CollaborationObject, PersistentBaseObject

public interface UserSubscription
extends CollaborationObject, PersistentBaseObject

Classes that implement the UserSubscription interface represent an specific teamspace event to which a member has subscribed. Whenever the specified event occurs, a notification is generated and delivered to the member based on the member's notification preferences.


Field Summary
static java.lang.String COLLABORATION_TYPE_SYMNAME
          Value of "CollaborationType"; Content Engine property.
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
           
static java.lang.String OWNER_TEAMSPACE_SYMNAME
           
static java.lang.String[] PROPERTIES
           
static java.lang.String SECURITYOWNERID_SYMNAME
           
static java.lang.String SUBSCRIPTIONOBJECTID_SYMNAME
           
static java.lang.String SUBSCRIPTIONOBJECTTYPE_SYMNAME
           
static java.lang.String SUBSCRIPTIONTYPE_SYMNAME
           
 
Method Summary
 java.lang.String getMemberID()
          Returns the ID of the teamspace member who created the UserSubscription object.
 com.filenet.wcm.api.BaseObject getSubscriptionObject()
          Returns the target object of the subscription.
 int getSubscriptionType()
          Returns an int value that defines the type of subscription that generated the notification.
 java.lang.String getTeamspaceID()
          Returns the ID of Teamspace object in which the event occurred.
 
Methods inherited from interface com.filenet.bso.api.collaboration.CollaborationObject
getSymbolicName, getType
 
Methods inherited from interface com.filenet.bso.api.collaboration.PersistentBaseObject
getBaseObject, getID, getObjectStore, getProperties, isMembershipManagedSecurity, isOwner, refresh, setProperties
 

Field Detail

SUBSCRIPTIONOBJECTID_SYMNAME

public static final java.lang.String SUBSCRIPTIONOBJECTID_SYMNAME

SUBSCRIPTIONOBJECTTYPE_SYMNAME

public static final java.lang.String SUBSCRIPTIONOBJECTTYPE_SYMNAME

SUBSCRIPTIONTYPE_SYMNAME

public static final java.lang.String SUBSCRIPTIONTYPE_SYMNAME

OWNER_TEAMSPACE_SYMNAME

public static final java.lang.String OWNER_TEAMSPACE_SYMNAME

MEMBERSHIPMANAGEDSECURITY_SYMNAME

public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME

SECURITYOWNERID_SYMNAME

public static final java.lang.String SECURITYOWNERID_SYMNAME

COLLABORATION_TYPE_SYMNAME

public static final java.lang.String COLLABORATION_TYPE_SYMNAME
Value of "CollaborationType"; Content Engine property.

PROPERTIES

public static final java.lang.String[] PROPERTIES
Method Detail

getMemberID

public java.lang.String getMemberID()
Returns the ID of the teamspace member who created the UserSubscription object.

Returns:
A String containing a member ID.

getSubscriptionType

public int getSubscriptionType()
Returns an int value that defines the type of subscription that generated the notification.

Returns:
An int value.

getTeamspaceID

public java.lang.String getTeamspaceID()
Returns the ID of Teamspace object in which the event occurred.

Returns:
A String object containing a teamspace ID.

getSubscriptionObject

public com.filenet.wcm.api.BaseObject getSubscriptionObject()
Returns the target object of the subscription.

Returns:
A BaseObject object.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.