| org.sakaiproject.entity.api.Reference
All known Subclasses: org.sakaiproject.entity.impl.ReferenceComponent,
| Reference | | public interface Reference (Code) | |
Reference holds an immutable reference to a Sakai entity.
|
| Method Summary | |
| void | addSiteContextAuthzGroup(Collection rv)
Add the AuthzGroup(s) for context as a site. | | void | addUserAuthzGroup(Collection rv, String id)
Add the AuthzGroup for this user id, or for the user's type template, or for the general template. | | void | addUserTemplateAuthzGroup(Collection rv, String id)
Add the AuthzGroup for this user id, or for the user's type template, or for the general template. | | Collection | getAuthzGroups()
Compute the set of AuthzGroup ids associated with this referenced resource. | | Collection | getAuthzGroups(String userId)
Compute the set of AuthzGroup ids associated with this referenced resource, perhaps customized for security about this end user.
Parameters:
userId - the end user ID, or null if we want the generic set. | | String | getContainer()
| | String | getContext()
Access the context id, if any. | | String | getDescription()
| | Entity | getEntity()
Find the Entity that is referenced. | | EntityProducer | getEntityProducer()
Access the entity producer responsible for the referenced entity. | | String | getId()
Access the primary id. | | ResourceProperties | getProperties()
Find the ResourceProperties object for this reference. | | String | getReference()
Access the reference. | | String | getSubType()
Access the subType. | | String | getType()
Access the type, an application id string. | | String | getUrl()
Access the URL which can be used to access the referenced resource. | | boolean | isKnownType()
| | boolean | set(String type, String subType, String id, String container, String context)
| | void | updateReference(String ref)
Update the reference string. |
| addSiteContextAuthzGroup | | void addSiteContextAuthzGroup(Collection rv)(Code) | | Add the AuthzGroup(s) for context as a site.
Parameters:
rv - The list. |
| addUserAuthzGroup | | void addUserAuthzGroup(Collection rv, String id)(Code) | | Add the AuthzGroup for this user id, or for the user's type template, or for the general template.
Parameters:
rv - The list.
Parameters:
id - The user id. |
| addUserTemplateAuthzGroup | | void addUserTemplateAuthzGroup(Collection rv, String id)(Code) | | Add the AuthzGroup for this user id, or for the user's type template, or for the general template.
Parameters:
rv - The list.
Parameters:
id - The user id. |
| getAuthzGroups | | Collection getAuthzGroups()(Code) | | Compute the set of AuthzGroup ids associated with this referenced resource.
List of AuthzGroup ids (String) associated with this referenced resource. |
| getAuthzGroups | | Collection getAuthzGroups(String userId)(Code) | | Compute the set of AuthzGroup ids associated with this referenced resource, perhaps customized for security about this end user.
Parameters:
userId - the end user ID, or null if we want the generic set. List of AuthzGroup ids (String) associated with this referenced resource. |
| getContainer | | String getContainer()(Code) | | Access a single container id, the from most general (or only)
The single or most general container, if any. |
| getContext | | String getContext()(Code) | | Access the context id, if any.
the context id, if any. |
| getDescription | | String getDescription()(Code) | | a description of the resource referenced. |
| getEntity | | Entity getEntity()(Code) | | Find the Entity that is referenced.
The Entity object that this references. |
| getEntityProducer | | EntityProducer getEntityProducer()(Code) | | Access the entity producer responsible for the referenced entity.
The EntityProducer responsible for the referenced entity, or null if there is none. |
| getId | | String getId()(Code) | | Access the primary id.
The primary id. |
| getProperties | | ResourceProperties getProperties()(Code) | | Find the ResourceProperties object for this reference.
A ResourcesProperties object found (or constructed) for this reference. |
| getReference | | String getReference()(Code) | | Access the reference.
The reference. |
| getSubType | | String getSubType()(Code) | | Access the subType.
The subType. |
| getType | | String getType()(Code) | | Access the type, an application id string. This value must uniquely identify the application responsible for the reference, and must be unchanging over time (it may end up stored in database values).
The type, an application id string. |
| getUrl | | String getUrl()(Code) | | Access the URL which can be used to access the referenced resource.
The URL which can be used to access the referenced resource. |
| isKnownType | | boolean isKnownType()(Code) | | Check if the reference's type is known
true if known, false if not. |
| set | | boolean set(String type, String subType, String id, String container, String context)(Code) | | Accept the settings for a reference - may be rejected if already set
Parameters:
type -
Parameters:
subType -
Parameters:
id -
Parameters:
container -
Parameters:
container2 -
Parameters:
context - true if settings are accepted, false if not. |
| updateReference | | void updateReference(String ref)(Code) | | Update the reference string.
Parameters:
ref - The new reference string. |
|
|