ChangeSynergy::FolderSecurityRule
The ChangeSynergy::FolderSecurityRule class represents a folder rule. A folder rule consists of the name of the folder, a list of users that have read access and a list of users that have write access. Users that have write access automatically have read access. The security for the System and Shared folders for Queries, Report Formats and Reports for both change requests and tasks can be modified using this class.
void |
addReadMember(scalar readMember) Adds a single user or group to the list of users that have read access to the folder. |
void |
addWriteMember(scalar writeMember) Adds a single user or group to the list of users that have write access to the folder. |
void |
deleteReadMember(scalar readMember) Deletes a single user or group from the list of users and groups that have read access to the folder. |
void |
deleteWriteMember(scalar writeMember) Deletes a single user or group from the list of users and groups that have write access to the folder. |
scalar |
getFolderName() Gets the name of the folder for this folder security rule. If the folder name is empty that means the folder security rule is for the "All" folder. |
array |
getReadMembers() Gets an array of the users and groups that have read access to the folder. |
array |
getWriteMembers() Gets an array of the users and groups that have write access to the folder. |
void |
setFolderName(scalar folderName) Sets the name of the folder for this folder security rule. Set the folder name to the empty string ("") if you want to set the folder security for the "All" folder. |
void |
setReadMembers(array readMembers) Sets the array of users and groups that have read access to the folder. |
void |
setWriteMembers(array writeMembers) Sets the array of users and groups that have write access to the folder. |
Adds a single user or group to the list of users and groups that have read access to the folder. If the user or group already exists in the list the call is a no-op.
Parameters: scalar: The name of user or group.
Example: my $folderRule = new ChangeSynergy::FolderSecurityRule(); $folderRule->addReadMember("user1");
Adds a single user or group to the list of users and groups that have write access to the folder. If the user or group already exists in the list the call is a no-op.
Parameters: scalar: The name of user or group.
Example: my $folderRule = new ChangeSynergy::FolderSecurityRule(); $folderRule->addWriteMember("user1");
Deletes a single user or group from the list of users and groups that have read access to the folder. If the user or group does not exist in the list the call is a no-op.
Parameters: scalar: The name of user or group.
Example: my $folderRule = new ChangeSynergy::FolderSecurityRule(); $folderRule->deleteReadMember("user1");
Deletes a single user or group from the list of users that have write access to the folder. If the user or group does not exist in the list the call is a no-op.
Parameters: scalar: The name of user or group.
Example: my $folderRule = new ChangeSynergy::FolderSecurityRule(); $folderRule->deleteWriteMember("user1");
Gets the name of the folder for this folder security rule. If the rule name is empty that means the folder security rule is for the "All" folder.
Returns: scalar The name of the folder.
Gets the array of users that have read access to the folder. That is the users who can view and run the queries, reports, etc in a given folder.
Returns: array The array of read members.
Gets the array of users that have write access to the folder. That is the users who can view, run and edit the queries, reports, etc in a given folder.
Returns: array The array of write members.
Sets the name of the folder for this folder security rule. Set the folder name to the empty string ("") if you want to set the folder security for the "All" folder.
Parameters: scalar: The name of the folder.
Example: my $folderRule = new ChangeSynergy::FolderSecurityRule(); $folderRule->setFolderName("My folder");
Sets the array of users that have read access to the folder. That is the users who can view and run the queries, reports, etc in a given folder.
Parameters: array: The list of users with read access.
Example: my $folderRule = new ChangeSynergy::FolderSecurityRule(); my @readers = ("Jane", "John", "Doe"); $folderRule->setReadMembers(\@readers);
Sets the array of users that have write access to the folder. That is the users who can view, run and edit the queries, reports, etc in a given folder.
Parameters: array: The list of users with write access.
Example: my $folderRule = new ChangeSynergy::FolderSecurityRule(); my @readers = ("Jane", "John", "Doe"); $folderRule->setWriteMembers(\@readers);