| java.lang.Object
 org.sakaiproject.entity.impl.ReferenceComponent
| ReferenceComponent | | public class ReferenceComponent implements Reference(Code) | |
Implementation of the Reference API
Note: a Reference is immutable.
|
| Method Summary | |
| public void | addSiteContextAuthzGroup(Collection rv)
Add the AuthzGroup(s) for context as a site. | | public 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. | | public 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. | | public Collection | getAuthzGroups()
| | public Collection | getAuthzGroups(String userId)
| | public String | getContainer()
| | public String | getContext()
Access the context id, if any. | | public String | getDescription()
| | public Entity | getEntity()
Find the Entity that is referenced. | | public EntityProducer | getEntityProducer()
| | public String | getId()
Access the primary id. | | public ResourceProperties | getProperties()
Find the ResourceProperties object for this reference. | | public String | getReference()
Access the reference. | | public String | getSubType()
Access the subType. | | public String | getType()
Access the type, a service id string. | | public String | getUrl()
Access the URL which can be used to access the referenced resource. | | public boolean | isKnownType()
| | protected void | parse()
| | public boolean | set(String type, String subType, String id, String container, String context)
| | public void | updateReference(String ref)
|
| GRADEBOOK_ROOT | | final public static String GRADEBOOK_ROOT(Code) | | These are some more services known.
|
| GRADTOOLS_ROOT | | final public static String GRADTOOLS_ROOT(Code) | | |
| M_log | | protected static Log M_log(Code) | | Our logger.
|
| m_container | | protected String m_container(Code) | | The reference containment ids.
|
| m_context | | protected String m_context(Code) | | Another container, the context id.
|
| m_reference | | protected String m_reference(Code) | | The reference string.
|
| m_setAlready | | protected boolean m_setAlready(Code) | | Set to true once the values are set.
|
| m_subType | | protected String m_subType(Code) | | The reference sub-type.
|
| m_type | | protected String m_type(Code) | | The reference type (a service name string).
|
| ReferenceComponent | | public ReferenceComponent(String ref)(Code) | | Construct with a reference string.
Parameters:
ref - The resource reference. |
| ReferenceComponent | | public ReferenceComponent(Reference copyMe)(Code) | | Construct with a Reference.
Parameters:
ref - The resource reference. |
| addSiteContextAuthzGroup | | public void addSiteContextAuthzGroup(Collection rv)(Code) | | Add the AuthzGroup(s) for context as a site.
Parameters:
rv - The list. |
| addUserAuthzGroup | | public 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 | | public 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. |
| getContainer | | public String getContainer()(Code) | | Access a single container id, the from most general (or only)
The single or most general container, if any. |
| getContext | | public String getContext()(Code) | | Access the context id, if any.
the context id, if any. |
| getDescription | | public String getDescription()(Code) | | a description of the resource referenced. |
| getEntity | | public Entity getEntity()(Code) | | Find the Entity that is referenced.
The Entity object that this references. |
| getId | | public String getId()(Code) | | Access the primary id.
The primary id. |
| getProperties | | public ResourceProperties getProperties()(Code) | | Find the ResourceProperties object for this reference.
A ResourcesProperties object found (or constructed) for this reference. |
| getReference | | public String getReference()(Code) | | Access the reference.
The reference. |
| getSubType | | public String getSubType()(Code) | | Access the subType.
The subType. |
| getType | | public String getType()(Code) | | Access the type, a service id string.
The type, a service id string. |
| getUrl | | public 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 | | public boolean isKnownType()(Code) | | Check if the reference's type is known
true if known, false if not. |
| parse | | protected void parse()(Code) | | |
| set | | public 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 | | public void updateReference(String ref)(Code) | | |
|
|