|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISCSUserAPI
The command API implementation of the user commands.
This implementation can be accessed directly via the ICommandFacade
class, using the API
name user, with the following syntax:
ISCSUserAPI commandAPI = (ISCSUserAPI)m_commandFacade.getCommandAPI ("user", m_commandFacade.getCommandTypeForName ("active"));
Field Summary | |
---|---|
static java.lang.String |
API_CATEGORY
Category for this Command API |
Method Summary | |
---|---|
ISCSUserAccount |
_createAccount()
Create a new user account object. |
ISCSUserRole |
_createRole()
Create a new user role object. |
ISCSUserObject |
_createUser()
Create a new user object. |
ISCSUserAlias |
_createUserAlias()
Create a new user alias object. |
ISCSUserAliasMapping |
_createUserAliasMapping()
Create a new user alias mapping object. |
ISCSUserAttributeInfo |
_createUserAttributeInfo()
Create a new user attribute info object. |
ISCSUserAliasActionResponse |
createAlias(ISCSContext SCSContext,
ISCSUserAlias alias)
Command that creates a new alias. |
ISCSUserAliasActionResponse |
createAlias(ISCSContext SCSContext,
ISCSUserAlias alias,
java.util.List users)
Command that creates a new alias. |
ISCSUserAliasActionResponse |
createAlias(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserAlias alias)
Command that creates a new alias. |
ISCSUserAliasActionResponse |
createAlias(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserAlias alias,
java.util.List users)
Command that creates a new alias. |
ISCSUserRoleActionResponse |
createRole(ISCSContext SCSContext,
ISCSUserRole userRole)
Add a role to the content server system. |
ISCSUserRoleActionResponse |
createRole(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserRole userRole)
Add a role to the content server system. |
ISCSUserActionResponse |
createUser(ISCSContext SCSContext,
ISCSUserObject userObject)
Create a new user in the content server. |
ISCSUserActionResponse |
createUser(ISCSContext SCSContext,
ISCSUserObject userObject,
ISCSUserAttributeInfo userAttributeInfo)
Create a new user in the content server. |
ISCSUserActionResponse |
createUser(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserObject userObject)
Create a new user in the content server. |
ISCSUserActionResponse |
createUser(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserObject userObject,
ISCSUserAttributeInfo userAttributeInfo)
Create a new user in the content server. |
ISCSUserAliasActionResponse |
deleteAlias(ISCSContext SCSContext,
java.lang.String name)
Command that deletes an existing alias. |
ISCSUserAliasActionResponse |
deleteAlias(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String name)
Command that deletes an existing alias. |
ISCSUserRoleActionResponse |
deleteRole(ISCSContext SCSContext,
java.lang.String roleName)
Delete a user role from the content server. |
ISCSUserRoleActionResponse |
deleteRole(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String roleName)
Delete a user role from the content server. |
ISCSServerResponse |
deleteSearchQuery(ISCSContext SCSContext,
java.lang.String queryTitle)
Removes search queries for a users PNE on the content server. |
ISCSServerResponse |
deleteSearchQuery(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String queryTitle)
Removes search queries for a users PNE on the content server. |
ISCSUserActionResponse |
deleteUser(ISCSContext SCSContext,
java.lang.String userName)
Delete a user from the content server. |
ISCSUserActionResponse |
deleteUser(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String userName)
Delete a user from the content server. |
ISCSUserAliasActionResponse |
editAlias(ISCSContext SCSContext,
ISCSUserAlias alias)
Command that modifies an existing alias. |
ISCSUserAliasActionResponse |
editAlias(ISCSContext SCSContext,
ISCSUserAlias alias,
java.util.List users)
Command that modifies an existing alias. |
ISCSUserAliasActionResponse |
editAlias(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserAlias alias)
Command that modifies an existing alias. |
ISCSUserAliasActionResponse |
editAlias(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserAlias alias,
java.util.List users)
Command that modifies an existing alias. |
ISCSUserRoleActionResponse |
editRole(ISCSContext SCSContext,
ISCSUserRole userRole)
Edit the user role information. |
ISCSUserRoleActionResponse |
editRole(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserRole userRole)
Edit the user role information. |
ISCSUserActionResponse |
editUser(ISCSContext SCSContext,
ISCSUserObject userObject)
Command that modifies an existing user. |
ISCSUserActionResponse |
editUser(ISCSContext SCSContext,
ISCSUserObject userObject,
ISCSUserAttributeInfo userAttributeInfo)
Command that modifies an existing user. |
ISCSUserActionResponse |
editUser(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserObject userObject)
Command that modifies an existing user. |
ISCSUserActionResponse |
editUser(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserObject userObject,
ISCSUserAttributeInfo userAttributeInfo)
Command that modifies an existing user. |
ICISAPIObjectFactory |
getObjectFactory()
Retrieve the object factory associated with this API |
ISCSUserPNEResponse |
getPNEData(ISCSContext SCSContext)
Retrieves the users PNE data binder which contains personal saved information, such as query parameters and query strings. |
ISCSUserPNEResponse |
getPNEData(ISCSRequestModifier requestModifier,
ISCSContext SCSContext)
Retrieves the users PNE data binder which contains personal saved information, such as query parameters and query strings. |
ISCSUserListAliasesResponse |
listAliases(ISCSContext SCSContext)
List the available aliases in the content server. |
ISCSUserListAliasesResponse |
listAliases(ISCSRequestModifier requestModifier,
ISCSContext SCSContext)
List the available aliases in the content server. |
ISCSRoleListResponse |
listRoles(ISCSContext SCSContext)
List the available roles in the content server. |
ISCSRoleListResponse |
listRoles(ISCSRequestModifier requestModifier,
ISCSContext SCSContext)
List the available roles in the content server. |
ISCSUserListResponse |
listUsers(ISCSContext SCSContext)
List the available users in the content server. |
ISCSUserListResponse |
listUsers(ISCSRequestModifier requestModifier,
ISCSContext SCSContext)
List the available users in the content server. |
ISCSQueryUserAttributesResponse |
queryUserAttributes(ISCSContext SCSContext,
java.lang.String userName)
Returns user attributes for a specific user. |
ISCSQueryUserAttributesResponse |
queryUserAttributes(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String userName)
Returns user attributes for a specific user. |
ISCSUserActionResponse |
registerUser(ISCSContext SCSContext,
ISCSUserObject userObject)
Command that registers a user. |
ISCSUserActionResponse |
registerUser(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSUserObject userObject)
Command that registers a user. |
ISCSServerResponse |
saveSearchQuery(ISCSContext SCSContext,
java.lang.String queryTitle,
java.lang.String queryText)
Save a search query to the users PNE on the content server. |
ISCSServerResponse |
saveSearchQuery(ISCSContext SCSContext,
java.lang.String queryTitle,
java.lang.String queryText,
java.lang.String queryDescription)
Save a search query to the users PNE on the content server. |
ISCSServerResponse |
saveSearchQuery(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String queryTitle,
java.lang.String queryText)
Save a search query to the users PNE on the content server. |
ISCSServerResponse |
saveSearchQuery(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String queryTitle,
java.lang.String queryText,
java.lang.String queryDescription)
Save a search query to the users PNE on the content server. |
ISCSCredentialValidateResponse |
validateCredentials(ISCSContext SCSContext,
java.lang.String userName,
java.lang.String password)
Validate user crendentials against the content server. |
ISCSCredentialValidateResponse |
validateCredentials(ISCSContext SCSContext,
java.lang.String userName,
java.lang.String password,
boolean retrieveAccounts,
boolean retrieveExtendedInfo)
Validate user crendentials against the content server. |
ISCSCredentialValidateResponse |
validateCredentials(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String userName,
java.lang.String password)
Validate user crendentials against the content server. |
ISCSCredentialValidateResponse |
validateCredentials(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String userName,
java.lang.String password,
boolean retrieveAccounts,
boolean retrieveExtendedInfo)
Validate user crendentials against the content server. |
Field Detail |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAPIObjectFactory getObjectFactory()
ISCSRoleListResponse listRoles(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSRoleListResponse listRoles(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSUserListResponse listUsers(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSUserListResponse listUsers(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSUserPNEResponse getPNEData(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSUserPNEResponse getPNEData(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSServerResponse deleteSearchQuery(ISCSContext SCSContext, java.lang.String queryTitle) throws CommandException
SCSContext
- the context object representing the current userqueryTitle
- the title of the query
CommandException
ISCSServerResponse deleteSearchQuery(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryTitle) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userqueryTitle
- the title of the query
CommandException
ISCSServerResponse saveSearchQuery(ISCSContext SCSContext, java.lang.String queryTitle, java.lang.String queryText) throws CommandException
SCSContext
- the context object representing the current userqueryTitle
- the title of the queryqueryText
- the query string
CommandException
ISCSServerResponse saveSearchQuery(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryTitle, java.lang.String queryText) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userqueryTitle
- the title of the queryqueryText
- the query string
CommandException
ISCSServerResponse saveSearchQuery(ISCSContext SCSContext, java.lang.String queryTitle, java.lang.String queryText, java.lang.String queryDescription) throws CommandException
SCSContext
- the context object representing the current userqueryTitle
- the title of the queryqueryText
- the query stringqueryDescription
- the query description
CommandException
ISCSServerResponse saveSearchQuery(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryTitle, java.lang.String queryText, java.lang.String queryDescription) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userqueryTitle
- the title of the queryqueryText
- the query stringqueryDescription
- the query description
CommandException
ISCSQueryUserAttributesResponse queryUserAttributes(ISCSContext SCSContext, java.lang.String userName) throws CommandException
SCSContext
- the context object representing the current useruserName
- the user name
CommandException
ISCSQueryUserAttributesResponse queryUserAttributes(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String userName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserName
- the user name
CommandException
ISCSUserAliasActionResponse createAlias(ISCSContext SCSContext, ISCSUserAlias alias) throws CommandException
SCSContext
- the context object representing the current useralias
- the alias object
CommandException
ISCSUserAliasActionResponse createAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserAlias alias) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useralias
- the alias object
CommandException
ISCSUserAliasActionResponse createAlias(ISCSContext SCSContext, ISCSUserAlias alias, java.util.List users) throws CommandException
SCSContext
- the context object representing the current useralias
- the alias objectusers
- a list of Strings containing the users to add to this alias
CommandException
ISCSUserAliasActionResponse createAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserAlias alias, java.util.List users) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useralias
- the alias objectusers
- a list of Strings containing the users to add to this alias
CommandException
ISCSUserRoleActionResponse createRole(ISCSContext SCSContext, ISCSUserRole userRole) throws CommandException
SCSContext
- the context object representing the current useruserRole
- the user role object
CommandException
ISCSUserRoleActionResponse createRole(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserRole userRole) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserRole
- the user role object
CommandException
ISCSUserActionResponse createUser(ISCSContext SCSContext, ISCSUserObject userObject) throws CommandException
SCSContext
- the context object representing the current useruserObject
- The user object
CommandException
ISCSUserActionResponse createUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserObject
- The user object
CommandException
ISCSUserActionResponse createUser(ISCSContext SCSContext, ISCSUserObject userObject, ISCSUserAttributeInfo userAttributeInfo) throws CommandException
SCSContext
- the context object representing the current useruserObject
- The user objectuserAttributeInfo
- the user attribute info
CommandException
ISCSUserActionResponse createUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject, ISCSUserAttributeInfo userAttributeInfo) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserObject
- The user objectuserAttributeInfo
- the user attribute info
CommandException
ISCSUserAliasActionResponse deleteAlias(ISCSContext SCSContext, java.lang.String name) throws CommandException
SCSContext
- the context object representing the current username
- the name of the alias
CommandException
ISCSUserAliasActionResponse deleteAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String name) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current username
- the name of the alias
CommandException
ISCSUserRoleActionResponse deleteRole(ISCSContext SCSContext, java.lang.String roleName) throws CommandException
SCSContext
- the context object representing the current userroleName
- the role name
CommandException
ISCSUserRoleActionResponse deleteRole(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String roleName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userroleName
- the role name
CommandException
ISCSUserActionResponse deleteUser(ISCSContext SCSContext, java.lang.String userName) throws CommandException
SCSContext
- the context object representing the current useruserName
- the user name
CommandException
ISCSUserActionResponse deleteUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String userName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserName
- the user name
CommandException
ISCSUserAliasActionResponse editAlias(ISCSContext SCSContext, ISCSUserAlias alias) throws CommandException
SCSContext
- the context object representing the current useralias
- the alias object
CommandException
ISCSUserAliasActionResponse editAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserAlias alias) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useralias
- the alias object
CommandException
ISCSUserAliasActionResponse editAlias(ISCSContext SCSContext, ISCSUserAlias alias, java.util.List users) throws CommandException
SCSContext
- the context object representing the current useralias
- the alias objectusers
- a list of Strings containing the users to add to this alias
CommandException
ISCSUserAliasActionResponse editAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserAlias alias, java.util.List users) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useralias
- the alias objectusers
- a list of Strings containing the users to add to this alias
CommandException
ISCSUserRoleActionResponse editRole(ISCSContext SCSContext, ISCSUserRole userRole) throws CommandException
SCSContext
- the context object representing the current useruserRole
- the user role object
CommandException
ISCSUserRoleActionResponse editRole(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserRole userRole) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserRole
- the user role object
CommandException
ISCSUserActionResponse editUser(ISCSContext SCSContext, ISCSUserObject userObject) throws CommandException
SCSContext
- the context object representing the current useruserObject
- The user object
CommandException
ISCSUserActionResponse editUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserObject
- The user object
CommandException
ISCSUserActionResponse editUser(ISCSContext SCSContext, ISCSUserObject userObject, ISCSUserAttributeInfo userAttributeInfo) throws CommandException
SCSContext
- the context object representing the current useruserObject
- The user objectuserAttributeInfo
- the user attribute info
CommandException
ISCSUserActionResponse editUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject, ISCSUserAttributeInfo userAttributeInfo) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserObject
- The user objectuserAttributeInfo
- the user attribute info
CommandException
ISCSUserListAliasesResponse listAliases(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSUserListAliasesResponse listAliases(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSUserActionResponse registerUser(ISCSContext SCSContext, ISCSUserObject userObject) throws CommandException
SCSContext
- the context object representing the current useruserObject
- the user object
CommandException
ISCSUserActionResponse registerUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserObject
- the user object
CommandException
ISCSCredentialValidateResponse validateCredentials(ISCSContext SCSContext, java.lang.String userName, java.lang.String password) throws CommandException
SCSContext
- the context object representing the current useruserName
- the username of the user to authenticatepassword
- the password of the user to authenticate, set to null to perform no authentication
CommandException
ISCSCredentialValidateResponse validateCredentials(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String userName, java.lang.String password) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserName
- the username of the user to authenticatepassword
- the password of the user to authenticate, set to null to perform no authentication
CommandException
ISCSCredentialValidateResponse validateCredentials(ISCSContext SCSContext, java.lang.String userName, java.lang.String password, boolean retrieveAccounts, boolean retrieveExtendedInfo) throws CommandException
SCSContext
- the context object representing the current useruserName
- the username of the user to authenticatepassword
- the password of the user to authenticate, set to null to perform no authenticationretrieveAccounts
- if true retrieves the user accountsretrieveExtendedInfo
- if true retrieves extended user information (full name, e-mail address, locale, and user type)
CommandException
ISCSCredentialValidateResponse validateCredentials(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String userName, java.lang.String password, boolean retrieveAccounts, boolean retrieveExtendedInfo) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current useruserName
- the username of the user to authenticatepassword
- the password of the user to authenticate, set to null to perform no authenticationretrieveAccounts
- if true retrieves the user accountsretrieveExtendedInfo
- if true retrieves extended user information (full name, e-mail address, locale, and user type)
CommandException
ISCSUserObject _createUser()
ISCSUserAttributeInfo _createUserAttributeInfo()
ISCSUserRole _createRole()
ISCSUserAccount _createAccount()
ISCSUserAlias _createUserAlias()
ISCSUserAliasMapping _createUserAliasMapping()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |