com.stdnet.moveit.api

Class MOVEitUserGroupInfo

java.lang.Object

com.stdnet.moveit.api.MOVEitObjectInfo

com.stdnet.moveit.api.MOVEitUserGroupInfo

public class MOVEitUserGroupInfo
extends MOVEitObjectInfo

Container object used to provide information about a specific user group on a MOVEit Transfer server. Instances of the object are returned by various methods of the Client object. An instance of the object is populated using information returned from the MOVEit Transfer host, and then passed on to the calling program, which can then access the information through the available methods.

Constructor Summary

Constructors

Constructor and Description
MOVEitUserGroupInfo()

Method Summary

Modifier and Type	Method and Description
int	adminFolderAccess() If set to 1, GroupAdmins of this group will have administrative access to the home folders of the group member users.
java.lang.String	adminFolderRelationship() Describes the specific permissions that GroupAdmins will have on group member's home folders, if AdminFolderAccess is set to 1.
int	adminTempUserAccess() If set to 1, GroupAdmins of this group will have administrative access to the temp users created by the group member users.
int	allowAttachments() If set to 1, and the organization is configured to allow attachments by group only, then members of this group will be allowed to add attachments to their secure messages.
int	allowSendPackages() If set to 1, and the organization is configured to allow sending packages by group only, then members of this group will be allowed to send packages.
int	canCreateTempUsers() DEPRECATED If set to 1, and the organization is configured to allow creation of temp users by group only, then members of this group will be allowed to create temp users.
java.lang.String	description() Description of this group.
java.lang.String	displayProfile() Name of the Display Profile applied to this group, if any.
long	ID() ID of this group.
int	instID() ID of the organization this group exists in.
long	maxMaxAttchSize() DEPRECATED Determines the maximum attachment size restriction that GroupAdmins of this group may assign to member users.
long	maxMemberAdHocQuota() Determines the maximum Ad Hoc quota restriction that GroupAdmins of this group may assign to member users.
long	maxMemberFolderQuota() Determines the maximum folder quota restriction that GroupAdmins of this group may assign to member users.
long	maxMemberPerPackageQuota() Determines the maximum attachment size restriction that GroupAdmins of this group may assign to member users.
long	maxMemberQuota() DEPRECATED Determines the maximum folder quota restriction that GroupAdmins of this group may assign to member users.
java.lang.String	name() Name of this group.
int	orgID() ID of the organization this group exists in.
int	sendToRegisteredUsersNotInAddrBook() If set to 1, and the organization is configured to allow sending packages to registered user not in users' address books by group only, then members of this group will be allowed to send packages to registered users who don't exist in their address book.
int	sendToUnregisteredRecip() If set to 1, and the organization is configured to allow sending packages to unregistered recipients by group only, then members of this group will be allowed to send packages to recipients that do not currently exist in the system.
int	tempUsersInAddrBookExpansion() If set to 1, temp users who are members of this group (Limited Members) will be included in address book expansion member lists of this group.

Methods inherited from class com.stdnet.moveit.api.MOVEitObjectInfo

dataInitialized

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MOVEitUserGroupInfo

public MOVEitUserGroupInfo()

Method Detail

ID

public long ID()

ID of this group.

Returns:

ID of group

name

public java.lang.String name()

Name of this group.

Returns:

Name of group

instID

public int instID()

ID of the organization this group exists in.

Returns:

Organization ID

orgID

public int orgID()

ID of the organization this group exists in.

Returns:

Organization ID

description

public java.lang.String description()

Description of this group.

Returns:

Description of group

adminFolderAccess

public int adminFolderAccess()

If set to 1, GroupAdmins of this group will have administrative access to the home folders of the group member users.

Returns:

GroupAdmin folder access setting

adminFolderRelationship

public java.lang.String adminFolderRelationship()

Describes the specific permissions that GroupAdmins will have on group member's home folders, if AdminFolderAccess is set to 1. The Permission string will contain one or more of the following letters: "AEDLNRW". (A=Admin, E=Subfolders, D=Delete, L=List, N=Notify, R=Read, W=Write)

Returns:

GroupAdmin folder relationship string

adminTempUserAccess

public int adminTempUserAccess()

If set to 1, GroupAdmins of this group will have administrative access to the temp users created by the group member users. These temp users are called Limited Members.

Returns:

GroupAdmin temp user access setting

allowAttachments

public int allowAttachments()

If set to 1, and the organization is configured to allow attachments by group only, then members of this group will be allowed to add attachments to their secure messages.

Returns:

1 if allowed; otherwise, 0.

canCreateTempUsers

public int canCreateTempUsers()

DEPRECATED If set to 1, and the organization is configured to allow creation of temp users by group only, then members of this group will be allowed to create temp users.

Returns:

Can create temp users setting

maxMaxAttchSize

public long maxMaxAttchSize()

DEPRECATED Determines the maximum attachment size restriction that GroupAdmins of this group may assign to member users. A value of 0 indicates no restriction.

Returns:

Maximum allowed attachment size restriction in bytes

maxMemberPerPackageQuota

public long maxMemberPerPackageQuota()

Determines the maximum attachment size restriction that GroupAdmins of this group may assign to member users. A value of 0 indicates no restriction.

Returns:

Maximum allowed attachment size restriction in bytes

maxMemberQuota

public long maxMemberQuota()

DEPRECATED Determines the maximum folder quota restriction that GroupAdmins of this group may assign to member users. A value of 0 indicates no restriction.

Returns:

Maximum allowed folder quota restriction in bytes

maxMemberFolderQuota

public long maxMemberFolderQuota()

Determines the maximum folder quota restriction that GroupAdmins of this group may assign to member users. A value of 0 indicates no restriction.

Returns:

Maximum allowed folder quota restriction in bytes

tempUsersInAddrBookExpansion

public int tempUsersInAddrBookExpansion()

If set to 1, temp users who are members of this group (Limited Members) will be included in address book expansion member lists of this group.

Returns:

Temp users in address book expansion setting

displayProfile

public java.lang.String displayProfile()

Name of the Display Profile applied to this group, if any.

NOTE: Will only be initialized when returned from the Client.getGroupDetails method.

Returns:

Currently applied Display Profile

allowSendPackages

public int allowSendPackages()

If set to 1, and the organization is configured to allow sending packages by group only, then members of this group will be allowed to send packages.

Returns:

1 if allowed; otherwise, 0.

maxMemberAdHocQuota

public long maxMemberAdHocQuota()

Determines the maximum Ad Hoc quota restriction that GroupAdmins of this group may assign to member users. A value of 0 indicates no restriction.

Returns:

Maximum allowed Ad Hoc quota restriction in bytes

sendToRegisteredUsersNotInAddrBook

public int sendToRegisteredUsersNotInAddrBook()

If set to 1, and the organization is configured to allow sending packages to registered user not in users' address books by group only, then members of this group will be allowed to send packages to registered users who don't exist in their address book.

Returns:

1 if allowed; otherwise, 0.

sendToUnregisteredRecip

public int sendToUnregisteredRecip()

If set to 1, and the organization is configured to allow sending packages to unregistered recipients by group only, then members of this group will be allowed to send packages to recipients that do not currently exist in the system.

Returns:

1 if allowed; otherwise, 0.