Package com.opentext.livelink.service.memberservice

Class MemberService_JAXWS

  • public class MemberService_JAXWS
extends java.lang.Object
    The MemberService provides methods for managing users and groups.
    Version:
    2014-07-29

    • Constructor Detail

      • MemberService_JAXWS

        public MemberService_JAXWS()

    • Method Detail

      • addListOfMembersToGroup

        public void addListOfMembersToGroup​(long groupID,
                                    long[] memberIDs)
        Adds a list of members to a group.
        Parameters:
        groupID - The ID of the group to add members to.
        memberIDs - The IDs of the members to add to the group.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the group's information.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.CouldNotUpdateGroup - An error occured when trying to update the group.
        MemberService.GroupIdNotValid - The group ID is an invalid ID.
        MemberService.MemberTypeGroupRequired - The group ID is not the ID of a group member.

      • addMemberToGroup

        public void addMemberToGroup​(long groupID,
                             long memberID)
        Adds a member to a group.
        Parameters:
        groupID - The ID of the group to add a member to.
        memberID - The ID of the member to add.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the group's information.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.CouldNotUpdateGroup - An error occured when trying to update the group.
        MemberService.GroupIdNotValid - You cannot add members to a group with an invalid ID.
        MemberService.MemberTypeGroupRequired - The group ID is not the ID of a group member.

      • convertExternalUserToUser

        public void convertExternalUserToUser​(long userID,
                                      long groupID,
                                      MemberPrivileges memberPrivileges)
        Converts an external user to a regular Content Server user.
        Parameters:
        userID - The ID of the external user.
        groupID - The ID of the group to add the user to.
        memberPrivileges - The user's new privileges in the system.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.InvalidGroupID - The specified group ID does not belong to an internal group.
        MemberService.InvalidMemberPrivileges - The specified MemberPrivileges object is null.
        MemberService.InvalidUserID - The specified user ID does not belong to an external user.
        Since:
        10.5.3

      • createDomain

        public long createDomain​(java.lang.String name)
        Creates a new domain.
        Parameters:
        name - The domain name.
        Returns:
        The ID of the domain.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.DomainsNotEnabled - You cannot create a domain when domain support is not enabled.
        MemberService.InvalidName - The given domain name is invalid.
        Since:
        10.0.11

      • createExternalGroup

        public long createExternalGroup​(java.lang.String name,
                                java.lang.Long leaderID)
        Creates a new external group.
        Parameters:
        name - The name of the group.
        leaderID - The ID of the leader of the group.
        Returns:
        The ID of the group.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.InvalidName - The given group name is invalid.
        Since:
        10.5.0

      • createExternalUser

        public long createExternalUser​(User user)
        Creates a new external user.
        Parameters:
        user - The creation information for the user.
        Returns:
        The ID of the user.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.InvalidName - The given username is invalid.
        MemberService.UserObjectRequired - You cannot create a new user without a user SDO.
        Since:
        10.5.0

      • createGroup

        public long createGroup​(java.lang.String name,
                        java.lang.Long leaderID)
        Creates a new group.
        Parameters:
        name - The name of the group.
        leaderID - The ID of the leader of the group.
        Returns:
        The ID of the group.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.InvalidName - The given group name is invalid.
        Since:
        10.0.11

      • createGroupInDomain

        public long createGroupInDomain​(java.lang.String name,
                                java.lang.Long leaderID,
                                long domainID)
        Creates a new group in a domain.
        Parameters:
        name - The name of the group.
        leaderID - The ID of the leader of the group.
        domainID - The ID of the domain.
        Returns:
        The ID of the group.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.DomainsNotEnabled - You cannot create a group in a domain when domain support is not enabled.
        MemberService.InvalidDomainID - The given domain ID is invalid.
        MemberService.InvalidName - The given group name is invalid.
        Since:
        10.0.11

      • createMember

        public Member createMember​(Member member)
        Deprecated.
        This method has been deprecated and the other Create* methods should be used instead.
        Creates a new member.
        Parameters:
        member - The creation information for the member.
        Returns:
        The created member.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotCreateGroup - An error occured when trying to create the group.
        MemberService.CouldNotCreateUser - An error occured when trying to create the user.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.GroupIDRequired - You cannot create a new user with an invalid group ID.
        MemberService.MemberIdMustNotBePreSet - You cannot create a new member with a preset ID.
        MemberService.MemberNameRequired - You cannot create a new member without a name.
        MemberService.MemberObjectRequired - You must pass in a valid Member object.
        MemberService.PasswordRequired - You cannot create a new member with an undefined password.

      • createUser

        public long createUser​(User user)
        Creates a new user.
        Parameters:
        user - The creation information for the user.
        Returns:
        The ID of the user.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.InvalidName - The given username is invalid.
        MemberService.UserObjectRequired - You cannot create a new user without a user SDO.
        Since:
        10.0.11

      • createUserInDomain

        public long createUserInDomain​(User user,
                               long domainID)
        Creates a new user in a domain.
        Parameters:
        user - The creation information for the user.
        domainID - The ID of the domain.
        Returns:
        The ID of the user.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.DomainsNotEnabled - You cannot create a user in a domain when domain support is not enabled.
        MemberService.InvalidDomainID - The given domain ID is invalid.
        MemberService.InvalidName - The given username is invalid.
        MemberService.UserObjectRequired - You cannot create a new user without a user SDO.
        Since:
        10.0.11

      • deleteListOfMembers

        public void deleteListOfMembers​(long[] memberIDs)
        Deletes a list of members.
        Parameters:
        memberIDs - The IDs of the members to delete.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotDeleteGroup - An error occured when trying to delete a group.
        MemberService.CouldNotDeleteUser - An error occured when trying to delete a user.
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the group's information.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberTypeUserOrGroupRequired - An ID of a member was given that is not a user or a group.

      • deleteMember

        public void deleteMember​(long memberID)
        Deletes a member.
        Parameters:
        memberID - The ID of the member to delete.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotDeleteGroup - An error occured when trying to delete a group.
        MemberService.CouldNotDeleteUser - An error occured when trying to delete a user.
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the group's information.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberIdNotValid - The member ID is an invalid ID.
        MemberService.MemberTypeUserOrGroupRequired - An ID of a member was given that is not a user or a group.

      • getAuthenticatedUser

        public User getAuthenticatedUser()
        Gets the user that is authenticated.
        Returns:
        The user that is authenticated.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the group's information.
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetPrgSession - An error occured when trying to get a program session.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberIdNotValid - The member ID is an invalid ID.
        MemberService.MemberTypeUserRequired - The member info returned is not a user.

      • getGroupByName

        public Group getGroupByName​(java.lang.String name)
        Gets a group by its name.
        Parameters:
        name - The name of the group.
        Returns:
        The found group or null if the group cannot be found.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberNameRequired - The name cannot be null or empty.
        MemberService.MemberTypeNotValid - A member was returned that is not a group or a user.

      • getGroupByNameInDomain

        public Group getGroupByNameInDomain​(java.lang.String name,
                                    long domainID)
        Gets a group in a specified domain by its name.
        Parameters:
        name - The name of the group.
        domainID - The ID of the domain.
        Returns:
        The found group or null if the group cannot be found.
        Since:
        10.0.12

      • getMemberById

        public Member getMemberById​(long memberID)
        Gets a member by their ID.
        Parameters:
        memberID - The ID of the member.
        Returns:
        The found member or null if the member cannot be found.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberIdNotValid - The member ID is not a valid ID.
        MemberService.MemberTypeNotValid - A member was returned that is not a group or a user.

      • getMemberByLoginName

        public Member getMemberByLoginName​(java.lang.String loginName)
        Gets a member by their login name.
        Parameters:
        loginName - The login name of the member.
        Returns:
        The found member or null if the member cannot be found.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberNameRequired - The login name cannot be null or empty.
        MemberService.MemberTypeNotValid - A member was returned that is not a group or a user.

      • getMembersByID

        public Member[] getMembersByID​(long[] memberIDs)
        Gets a list of members by their IDs.
        Parameters:
        memberIDs - The IDs of the members.
        Returns:
        A list of the found members. An element in the list will be null if a member cannot be found.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberIdNotValid - The member ID is not a valid ID.
        MemberService.MemberTypeNotValid - A member was returned that is not a group or a user.

      • getMetadataLanguage

        public java.lang.String getMetadataLanguage()
        Gets the current user's preferred metadata language.
        Returns:
        The language code of the current user's preferred metadata language.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.Error - There was an error getting the current user's preferred language.
        Since:
        10.0.0

      • getSearchResults

        public MemberSearchResults getSearchResults​(PageHandle pageHandle)
        Gets the results of searching for members.
        Parameters:
        pageHandle - The page handle of the search results.
        Returns:
        The search results.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotExpandUserData - An error occured when trying to get the user data.
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the search results.
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.CouldNotLoadPageHandle - An error occured when trying to load the page handle.
        MemberService.CouldNotUpdatePageHandle - An error occured when trying to update the page handle.
        MemberService.MemberTypeNotValid - A member was returned that is not a group or a user.
        MemberService.PageHandleRequired - The page handle cannot be null.
        MemberService.ValidPageHandleIDRequired - The page handle ID is not valid.

      • getUserByLoginName

        public User getUserByLoginName​(java.lang.String loginName)
        Gets a user by their login name.
        Parameters:
        loginName - The login name of the user.
        Returns:
        The found user or null if the user cannot be found.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberNameRequired - The login name cannot be null or empty.
        MemberService.MemberTypeNotValid - A member was returned that is not a group or a user.

      • getUserByLoginNameInDomain

        public User getUserByLoginNameInDomain​(java.lang.String loginName,
                                       long domainID)
        Gets a user in a specified domain by their login name.
        Parameters:
        loginName - The login name of the user.
        domainID - The ID of the domain.
        Returns:
        The found user or null if the user cannot be found.
        Since:
        10.0.12

      • listMemberOf

        public Group[] listMemberOf​(long memberID)
        Gets the groups a member belongs to.
        Parameters:
        memberID - The ID of the member.
        Returns:
        A list of groups the member belongs to.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetGroupsThatMemberBelongsTo - An error occured when trying to get the groups the member belongs to.
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the member information.
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberIdNotValid - The member ID is not a valid ID.
        MemberService.MemberTypeNotValid - A member was returned that is not a group or a user.
        MemberService.MemberTypeUserOrGroupRequired - An ID of a member was given that is not a user or a group.

      • listMembers

        public Member[] listMembers​(long groupID)
        Gets the members of a group.
        Parameters:
        groupID - The ID of the group.
        Returns:
        A list of members that belong to the group or null if there are no members in the group.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the member information.
        MemberService.CouldNotGetMemberSDO - An error occured when trying to load the Member SDO.
        MemberService.CouldNotGetMembersOfGroup - An error occured when trying to get the members of the group.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.MemberIdNotValid - The member ID is not a valid ID.
        MemberService.MemberTypeGroupRequired - The group ID is not the ID of a group member.

      • listRightsByID

        public MemberRight[] listRightsByID​(long id)
        Gets the rights for a member.
        Parameters:
        id - The ID of member
        Returns:
        A list of rights for the member.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.MemberIdNotValid - The member ID is not valid.
        Since:
        10.0.0

      • removeListOfMembersFromGroup

        public void removeListOfMembersFromGroup​(long groupID,
                                         long[] memberIDs)
        Removes a list of members from a group.
        Parameters:
        groupID - The ID of the group to remove members from.
        memberIDs - The IDs of the members to remove.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the member information.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.CouldNotUpdateGroup - An error occured when trying to update the group.
        MemberService.GroupIdNotValid - The group ID is not a valid ID.
        MemberService.MemberTypeGroupRequired - The group ID is not the ID of a group member.

      • removeMemberFromGroup

        public void removeMemberFromGroup​(long groupID,
                                  long memberID)
        Removes a member from a group.
        Parameters:
        groupID - The ID of the group to remove a member from.
        memberID - The ID of the member to remove.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the member information.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.CouldNotUpdateGroup - An error occured when trying to update the group.
        MemberService.GroupIdNotValid - The group ID is not a valid ID.
        MemberService.MemberTypeGroupRequired - The group ID is not the ID of a group member.

      • searchForMembers

        public PageHandle searchForMembers​(MemberSearchOptions options)
        Searches for members.
        Parameters:
        options - The options used to search.
        Returns:
        A page handle used to retrieve the search results.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotCreatePageHandle - An error occured when trying to create the page handle.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.ScopeOfGroupRequiresValidGroupID - The group scope requires a valid group ID.
        MemberService.SearchOptionsObjectRequired - The search options cannot be null.

      • setMetadataLanguage

        public void setMetadataLanguage​(java.lang.String languageCode)
        Sets the current user's preferred metadata language.
        Parameters:
        languageCode - The language code of the language to set to. If null, sets to the system default language.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.Error - There was an error getting or setting the current user's preferred language.
        MemberService.InvalidLanguageCode - The language code is not enabled or it is not valid.
        Since:
        10.0.0

      • updateMember

        public Member updateMember​(Member member)
        Updates a member.
        Parameters:
        member - The member's updated information.
        Returns:
        The updated member.
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.CouldNotUpdateGroup - An error occured when trying to update the group.
        MemberService.CouldNotUpdateUser - An error occured when trying to update the user.
        MemberService.MemberIdNotValid - The member ID is not a valid ID.
        MemberService.MemberObjectRequired - The member cannot be null.
        MemberService.MemberTypeUserOrGroupRequired - The ID of the member is not a user or a group.

      • updatePassword

        public void updatePassword​(long memberID,
                           java.lang.String newPassword,
                           java.lang.String oldPassword)
        Updates a user's password.
        Parameters:
        memberID - The ID of the member to update the password for.
        newPassword - The user's new password.
        oldPassword - The user's old password (optional if user can administer users).
        Throws:
        SoapFaultException - with fault codes:
        MemberService.CouldNotGetMemberInformation - An error occured when trying to get the member information.
        MemberService.CouldNotGetUapiSession - An error occured when trying to get a UAPI Session.
        MemberService.CouldNotUpdatePassword - An error occured when trying to update the user's password.
        MemberService.MemberIdNotValid - The member ID is not a valid ID.
        MemberService.MemberTypeUserRequired - The member info returned is not a user.
        MemberService.UsersNewPasswordRequired - The new password cannot be null.
        MemberService.UsersOldPasswordRequired - The user's old password is required.