| org.sakaiproject.alias.api.AliasService
All known Subclasses: org.sakaiproject.alias.impl.BaseAliasService,
| AliasService | | public interface AliasService extends EntityProducer(Code) | |
AliasService provides a single unque namespace where Sakai entities can have alternate case-insenstive names.
|
| Method Summary | |
| AliasEdit | add(String id)
Add a new alias. | | String | aliasReference(String id)
Access the internal reference which can be used to access the resource from within the system.
Parameters:
id - The alias id string. | | boolean | allowAdd()
Check to see if the current user can add an alias. | | boolean | allowEdit(String id)
Check to see if the current user can edit this alias.
Parameters:
id - The alias id string. | | boolean | allowRemoveAlias(String alias)
Check to see if the current user can remove this alias.
Parameters:
alias - The alias. | | boolean | allowRemoveTargetAliases(String target)
Check to see if the current user can remove these aliasese for this target resource reference.
Parameters:
target - The target resource reference string. | | boolean | allowSetAlias(String alias, String target)
Check if the current user has permission to set this alias.
Parameters:
alias - The alias.
Parameters:
target - The resource reference string alias target. | | void | cancel(AliasEdit edit)
Cancel the changes made to a AliasEdit object, and release the lock. | | void | commit(AliasEdit edit)
Commit the changes made to a AliasEdit object, and release the lock. | | int | countAliases()
Count all the aliases. | | int | countSearchAliases(String criteria)
Count all the aliases that match this criteria in id or target. | | AliasEdit | edit(String id)
Get a locked alias object for editing. | | List | getAliases(String target)
Find all the aliases defined for this target.
Parameters:
target - The target resource reference string. | | List | getAliases(String target, int first, int last)
Find all the aliases defined for this target, within the record range given (sorted by id).
Parameters:
target - The target resource reference string.
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. | | List | getAliases(int first, int last)
Find all the aliases within the record range given (sorted by id).
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. | | String | getTarget(String alias)
Find the target resource reference string associated with this alias.
Parameters:
alias - The alias. | | void | remove(AliasEdit edit)
Remove this alias information - it must be a user with a lock from edit(). | | void | removeAlias(String alias)
Remove an alias. | | void | removeTargetAliases(String target)
Remove all aliases for this target resource reference, if any. | | List | searchAliases(String criteria, int first, int last)
Search all the aliases that match this criteria in id or target, returning a subset of records within the record range given (sorted by id).
Parameters:
criteria - The search criteria.
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. | | void | setAlias(String alias, String target)
|
| APPLICATION_ID | | final static String APPLICATION_ID(Code) | | The type string for this application: should not change over time as it may be stored in various parts of persistent entities.
|
| REFERENCE_ROOT | | final static String REFERENCE_ROOT(Code) | | This string starts the references to resources in this service.
|
| SECURE_ADD_ALIAS | | final static String SECURE_ADD_ALIAS(Code) | | Name for the event of adding an alias.
|
| SECURE_REMOVE_ALIAS | | final static String SECURE_REMOVE_ALIAS(Code) | | Name for the event of removing an alias.
|
| SECURE_UPDATE_ALIAS | | final static String SECURE_UPDATE_ALIAS(Code) | | Name for the event of updating an alias.
|
| aliasReference | | String aliasReference(String id)(Code) | | Access the internal reference which can be used to access the resource from within the system.
Parameters:
id - The alias id string. The the internal reference which can be used to access the resource from within the system. |
| allowAdd | | boolean allowAdd()(Code) | | Check to see if the current user can add an alias.
true if the current user can add an alias, false if not. |
| allowEdit | | boolean allowEdit(String id)(Code) | | Check to see if the current user can edit this alias.
Parameters:
id - The alias id string. true if the current user can edit this alias, false if not. |
| allowRemoveAlias | | boolean allowRemoveAlias(String alias)(Code) | | Check to see if the current user can remove this alias.
Parameters:
alias - The alias. true if the current user can remove this alias, false if not. |
| allowRemoveTargetAliases | | boolean allowRemoveTargetAliases(String target)(Code) | | Check to see if the current user can remove these aliasese for this target resource reference.
Parameters:
target - The target resource reference string. true if the current user can remove these aliasese for this target resource reference, false if not. |
| allowSetAlias | | boolean allowSetAlias(String alias, String target)(Code) | | Check if the current user has permission to set this alias.
Parameters:
alias - The alias.
Parameters:
target - The resource reference string alias target. true if the current user has permission to set this alias, false if not. |
| cancel | | void cancel(AliasEdit edit)(Code) | | Cancel the changes made to a AliasEdit object, and release the lock. The AliasEdit is disabled, and not to be used after this call.
Parameters:
user - The AliasEdit object to commit. |
| commit | | void commit(AliasEdit edit)(Code) | | Commit the changes made to a AliasEdit object, and release the lock. The AliasEdit is disabled, and not to be used after this call.
Parameters:
user - The AliasEdit object to commit. |
| countAliases | | int countAliases()(Code) | | Count all the aliases.
The count of all aliases. |
| countSearchAliases | | int countSearchAliases(String criteria)(Code) | | Count all the aliases that match this criteria in id or target.
The count of all aliases matching the criteria. |
| getAliases | | List getAliases(String target)(Code) | | Find all the aliases defined for this target.
Parameters:
target - The target resource reference string. A list (Alias) of all the aliases defined for this target. |
| getAliases | | List getAliases(String target, int first, int last)(Code) | | Find all the aliases defined for this target, within the record range given (sorted by id).
Parameters:
target - The target resource reference string.
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. A list (Alias) of all the aliases defined for this target, within the record range given (sorted by id). |
| getAliases | | List getAliases(int first, int last)(Code) | | Find all the aliases within the record range given (sorted by id).
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. A list (Alias) of all the aliases within the record range given (sorted by id). |
| getTarget | | String getTarget(String alias) throws IdUnusedException(Code) | | Find the target resource reference string associated with this alias.
Parameters:
alias - The alias. The target resource reference string associated with this alias.
throws:
IdUnusedException - if the alias is not defined. |
| remove | | void remove(AliasEdit edit) throws PermissionException(Code) | | Remove this alias information - it must be a user with a lock from edit(). The AliasEdit is disabled, and not to be used after this call.
Parameters:
edit - The locked AliasEdit object to remove.
exception:
PermissionException - if the current user does not have permission to remove this alias. |
| removeTargetAliases | | void removeTargetAliases(String target) throws PermissionException(Code) | | Remove all aliases for this target resource reference, if any.
Parameters:
target - The target resource reference string.
throws:
PermissionException - if the current user does not have permission to remove these aliases. |
| searchAliases | | List searchAliases(String criteria, int first, int last)(Code) | | Search all the aliases that match this criteria in id or target, returning a subset of records within the record range given (sorted by id).
Parameters:
criteria - The search criteria.
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. A list (Alias) of all the aliases matching the criteria, within the record range given (sorted by id). |
|
|