com.ibm.portal.ac
Interface ManagedProtectedResourceController

All Superinterfaces:
Identifiable, ManagedProtectedResource, ProtectedResource

public interface ManagedProtectedResourceController
extends ManagedProtectedResource

The ManagedProtectedResourceController provides write access to the properties of a protected resource. Properties that can be modified are propagation role blocks, inheritance role blocks and the owner of the resource.

Since:
6.1.0.3

Method Summary
 void addInheritanceBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
          Adds the given collection of role types to the set of role types that the resource blocks for inheritance (the resource will not inherit these role types from a parent resource).
 void addPropagationBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
          Adds the given collection of role types to the set of role types that the resource blocks for propagation (child resources will not inherit these role types).
 void removeInheritanceBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
          Removes the given collection of role types from the set of role types that the resource blocks for inheritance (the resource will then inherit these role types from a parent resource).
 void removePropagationBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
          Removes the given collection of role types from the set of role types that the resource blocks for propagation (child resources will then inherit these role types).
 void setInheritanceBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
          Set the list of role types that the resource blocks for inheritance (the resource will not inherit these role types from a parent resource).
 void setOwner(Principal newOwner)
          Changes the owner of the resource.
 void setPropagationBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
          Set the list of role types that the resource blocks for propagation (child resources will not inherit these role types).
Pass an empty collection for clearing role blocks.
 
Methods inherited from interface com.ibm.portal.ac.ManagedProtectedResource
getInheritanceBlockedRoleTypes, getOwner, getPropagationBlockedRoleTypes, isExternalized, isPrivate
 
Methods inherited from interface com.ibm.portal.Identifiable
getObjectID
 

Method Detail

addInheritanceBlockedRoleTypes

void addInheritanceBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
                                    throws AccessControlException,
                                           SystemException,
                                           MissingAccessRightsException
Adds the given collection of role types to the set of role types that the resource blocks for inheritance (the resource will not inherit these role types from a parent resource).

Parameters:
roleTypes - Collection of RoleType objects, not null
Throws:
AccessControlException - will be thrown if any error occurred during the operation
SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation

addPropagationBlockedRoleTypes

void addPropagationBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
                                    throws AccessControlException,
                                           SystemException,
                                           MissingAccessRightsException
Adds the given collection of role types to the set of role types that the resource blocks for propagation (child resources will not inherit these role types).

Parameters:
roleTypes - Collection of RoleType objects, not null
Throws:
AccessControlException - will be thrown if any error occurred during the operation
SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation

setInheritanceBlockedRoleTypes

void setInheritanceBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
                                    throws AccessControlException,
                                           SystemException,
                                           MissingAccessRightsException
Set the list of role types that the resource blocks for inheritance (the resource will not inherit these role types from a parent resource).

Parameters:
roleTypes - Collection of RoleType objects, not null
Throws:
AccessControlException - will be thrown if any error occurred during the operation
SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation

setPropagationBlockedRoleTypes

void setPropagationBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
                                    throws AccessControlException,
                                           SystemException,
                                           MissingAccessRightsException
Set the list of role types that the resource blocks for propagation (child resources will not inherit these role types).
Pass an empty collection for clearing role blocks.

Parameters:
roleTypes - Collection of RoleType objects, not null
Throws:
AccessControlException - will be thrown if any error occurred during the operation
SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation

removeInheritanceBlockedRoleTypes

void removeInheritanceBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
                                       throws AccessControlException,
                                              SystemException,
                                              MissingAccessRightsException
Removes the given collection of role types from the set of role types that the resource blocks for inheritance (the resource will then inherit these role types from a parent resource).

Parameters:
roleTypes - Collection of RoleType objects, not null
Throws:
AccessControlException - will be thrown if any error occurred during the operation
SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation

removePropagationBlockedRoleTypes

void removePropagationBlockedRoleTypes(java.util.Collection<RoleType> roleTypes)
                                       throws AccessControlException,
                                              SystemException,
                                              MissingAccessRightsException
Removes the given collection of role types from the set of role types that the resource blocks for propagation (child resources will then inherit these role types).

Parameters:
roleTypes - Collection of RoleType objects, not null
Throws:
AccessControlException - will be thrown if any error occurred during the operation
SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation

setOwner

void setOwner(Principal newOwner)
              throws AccessControlException,
                     SystemException,
                     MissingAccessRightsException
Changes the owner of the resource. The current logged in user has to have appropriate privileges to perform this action, or a MissingAccessRightsException will be thrown.

Parameters:
newOwner - A Principal object representing the new owner, can be null if the resource should not have an owner.
Throws:
AccessControlException - thrown if the operation failed.
MissingAccessRightsException - if the current user does not have enough access rights to perform this action.
SystemException