com.fatwire.assetapi.site

Interface RoleManager

@Exported
public interface RoleManager

Role Manager class that handles roles CRUD operations

Method Summary

Modifier and Type	Method and Description
void	create(List<Role> roles) Create a list of roles in Content Server
void	delete(List<String> rolenames) Delete the list of roles from Content Server
QueryResultWrapper<List<Role>>	read(Condition query) Read a list of roles from Content Server with a Condition.
QueryResultWrapper<List<Role>>	read(Condition query, List<SortOrder> sortorders, int start, int count) Read a list of roles from Content Server with a Condition.
List<Role>	read(List<String> names) Read a list of Roles from Content Server with list of Role names
void	update(List<Role> roles) Update the existing roles in Content Server with new information

Method Detail

read

List<Role> read(List<String> names)
         throws SiteAccessException

Read a list of Roles from Content Server with list of Role names

Parameters:

names - the list of string role names

Returns:

the list of Roles of given name

Throws:

SiteAccessException - will throw exception if errors met when reading the roles

read

QueryResultWrapper<List<Role>> read(Condition query)
                             throws SiteAccessException

Read a list of roles from Content Server with a Condition. For now, we only support query for role name and description

Parameters:

query - the Condition for reading the roles

Returns:

the list of Roles that satisfies the Condition

Throws:

SiteAccessException - will throw exception if errors met when reading the roles

read

QueryResultWrapper<List<Role>> read(Condition query,
                                    List<SortOrder> sortorders,
                                    int start,
                                    int count)
                             throws SiteAccessException

Read a list of roles from Content Server with a Condition. For now, we only support query for role name and description

Parameters:

query - the Condition for reading the roles - only name, description are supported

sortorders - the attributes of roles that the results will be sorted upon - only name, description are supported

start - the start number where you want to results from

count - the total number sites you want the list contain

Returns:

the list of Roles that satisfies the Condition

Throws:

SiteAccessException - will throw exception if errors met when reading the roles

create

void create(List<Role> roles)
     throws SiteAccessException

Create a list of roles in Content Server

Parameters:

roles - the list of roles to create in Content Server

Throws:

SiteAccessException - will throw exception if errors met when creating the roles

update

void update(List<Role> roles)
     throws SiteAccessException

Update the existing roles in Content Server with new information

Parameters:

roles - the list of roles to update

Throws:

SiteAccessException - will throw exception if errors met when updating the roles

delete

void delete(List<String> rolenames)
     throws SiteAccessException

Delete the list of roles from Content Server

Parameters:

rolenames - the list of role names to delete

Throws:

SiteAccessException - will throw exception if errors met when deleting the roles