Package com.logicaldoc.gui.frontend.client.services

Interface RetentionPoliciesService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

@RemoteServiceRelativePath("retentionpolicies")
public interface RetentionPoliciesService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the RetentionPolicies Service. This service gives all needed methods to handle the retention policies.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RetentionPoliciesService.Instance

Method Summary

Modifier and Type	Method	Description
void	changeStatus(long id, boolean enabled)	Changes a policy enabled/disabled status
void	delete(long id)	Deletes a given policy
GUIRetentionPolicy	getPolicy(long id)	Loads a given policy from the database
void	reorder(long[] ids)	Reorder the policies
GUIRetentionPolicy	save(GUIRetentionPolicy policy)	Creates or updates a retention policy

Method Detail

delete

void delete(long id)
     throws ServerException

Deletes a given policy

Parameters:

id - identifier of the retention policy

Throws:

ServerException - an error happened in the server application

save

GUIRetentionPolicy save(GUIRetentionPolicy policy)
                 throws ServerException

Creates or updates a retention policy

Parameters:

policy - the retention policy to save

Returns:

the saved retention policy

Throws:

ServerException - an error happened in the server application

getPolicy

GUIRetentionPolicy getPolicy(long id)
                      throws ServerException

Loads a given policy from the database

Parameters:

id - identifiers of the policy

Returns:

the saved retention policy

Throws:

ServerException - an error happened in the server application

reorder

void reorder(long[] ids)
      throws ServerException

Reorder the policies

Parameters:

ids - identifier of the policies to reorder

Throws:

ServerException - an error happened in the server application

changeStatus

void changeStatus(long id,
                  boolean enabled)
           throws ServerException

Changes a policy enabled/disabled status

Parameters:

id - identifier of the policy to enable/disable

enabled - the enabled status of the policy

Throws:

ServerException - an error happened in the server application