com.plumtree.server
Interface IPTInvitation

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTInvitation
extends IPTObject

Administrative and browsing interface for modifying and accessing an invitation.

Author:
Robert Zhang

Method Summary
 java.lang.String CreateNewInvitationCode(java.lang.String strName, com.plumtree.openfoundation.util.XPDateTime dtExpirationDate, int nNumInvites)
           
 int GetDefaultProfileID()
          Gets the Default Profile ID set for this Invitation.
 int GetUserFolderID()
          Gets the Folder ID where new users are created.
 java.lang.Object[] GetUserGroupIDs()
          Gets the usergroups newly created users automatically become member of.
 IPTQueryResult QueryInvitationCodes()
          Queries for all the active invitation codes.
 void SetDefaultProfileID(int nDefaultProfileID)
          Sets a Default Profile ID for this Invitation.
 void SetUserFolderID(int nUserFolderID)
          Sets the ID of the Admin Folder where new users created from invitations are created.
 void SetUserGroupIDs(int[] arUserGroupIDs)
          Sets the usergroups newly created users automatically become member of.
 void SetUserGroupIDs(java.lang.Object[] arUserGroupIDs)
          Sets the usergroups newly created users automatically become member of.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

GetDefaultProfileID

int GetDefaultProfileID()
Gets the Default Profile ID set for this Invitation.

Returns:
int ID of a default user profile

SetDefaultProfileID

void SetDefaultProfileID(int nDefaultProfileID)
Sets a Default Profile ID for this Invitation.

Parameters:
nDefaultProfileID - ID of a default user profile. Needs at least SELECT access to the default user profile object.

GetUserGroupIDs

java.lang.Object[] GetUserGroupIDs()
Gets the usergroups newly created users automatically become member of.

Returns:
Object[] Array of Integer's with UserGroup IDs.

SetUserGroupIDs

void SetUserGroupIDs(int[] arUserGroupIDs)
Sets the usergroups newly created users automatically become member of.

Parameters:
arUserGroupIDs - Array of int's with unique UserGroup IDs. Need at least EDIT access to all Groups. Empty array or null to clear.

SetUserGroupIDs

void SetUserGroupIDs(java.lang.Object[] arUserGroupIDs)
Sets the usergroups newly created users automatically become member of.

Parameters:
arUserGroupIDs - Array of Integer's with unique UserGroup IDs. Need at least EDIT access to all Groups. Empty array or null to clear.

QueryInvitationCodes

IPTQueryResult QueryInvitationCodes()
Queries for all the active invitation codes.

Returns:
IPTQueryResult All active invitations. With PT_PROPID_INVITATION_EXPIRATIONDATE, PT_PROPID_INVITATION_INVITATIONCODE and PT_PROPID_INVITATION_NUMINVITES columns.
See Also:
PT_PROPIDS

CreateNewInvitationCode

java.lang.String CreateNewInvitationCode(java.lang.String strName,
                                         com.plumtree.openfoundation.util.XPDateTime dtExpirationDate,
                                         int nNumInvites)
Parameters:
strName -
dtExpirationDate -
nNumInvites -
Returns:
String

GetUserFolderID

int GetUserFolderID()
Gets the Folder ID where new users are created.

Returns:
int Admin Folder ID

SetUserFolderID

void SetUserFolderID(int nUserFolderID)
Sets the ID of the Admin Folder where new users created from invitations are created.

Parameters:
nUserFolderID - An Admin Folder ID, need at least EDIT access to the folder.


Copyright 2008 Plumtree Software Inc. All Rights Reserved.