Package com.opentext.livelink.service.collaboration

Class Collaboration_JAXWS

  • public class Collaboration_JAXWS
extends java.lang.Object
    Collaboration defines the service that is responsible for collaboration-related operations in Content Server, such as manipulating Projects, Discussions, and Tasks.
    Version:
    2013-08-26

    • Constructor Detail

      • Collaboration_JAXWS

        public Collaboration_JAXWS()

    • Method Detail

      • createChannel

        public Node createChannel​(ChannelInfo channelInfo)
        Creates a new channel.
        Parameters:
        channelInfo - The creation information for the channel.
        Returns:
        The created channel. Throws fault exception with error codes: Collaboration.ChannelInfoObjectRequired, Collaboration.CouldNotLoadNodeSDO, Collaboration.ChannelIDMustNotBePreset, Collaboration.CreatedByValueMustNotBePreset, Collaboration.UnableToGetParent.

      • createDiscussion

        public Node createDiscussion​(DiscussionInfo discussionInfo)
        Creates a new discussion.
        Parameters:
        discussionInfo - The creation information for the discussion.
        Returns:
        The created discussion. Throws fault exception with error codes: Collaboration.CouldNotLoadNodeSDO, Collaboration.DiscussionInfoObjectRequired, Collaboration.UnableToGetParent.

      • createMilestone

        public Node createMilestone​(MilestoneInfo milestoneInfo)
        Creates a new milestone.
        Parameters:
        milestoneInfo - The creation information for the milestone.
        Returns:
        The created milestone. Throws fault exception with error codes: Collaboration.CouldNotLoadNodeSDO, Collaboration.MilestoneInfoObjectRequired, Collaboration.InvalidTargetDate, Collaboration.InvalidActualDate, Collaboration.UnableToGetParent.

      • createNews

        public Node createNews​(NewsInfo newsInfo,
                       java.lang.Long livelinkAttachment,
                       Attachment attach)
        Creates a new news item.
        Parameters:
        newsInfo - The creation information for the news item.
        livelinkAttachment - The ID of a document to be attached to the news item.
        fileAtts - The description of a desktop document to be attached to the news item.
        inStream - The file stream of the desktop attachment.
        Returns:
        The created news item. Throws fault exception with error codes: Collaboration.NewsInfoObjectRequired, Collaboration.CouldNotLoadNodeSDO, Collaboration.NewsIDMustNotBePreset, Collaboration.CreatedByValueMustNotBePreset, Collaboration.UnableToGetParent, Collaboration.EffectiveDateShouldBeBeforeExpirationDate, Collaboration.CouldNotSetAttachmentReadOnly, Collaboration.CouldNotPopulateNodeSDO, Collaboration.CouldNotAllocateNodeSDO, Collaboration.UnableToFindCreatedNode.

      • createProject

        public Node createProject​(ProjectInfo projectInfo)
        Creates a new project.
        Parameters:
        projectInfo - The creation information for the project.
        Returns:
        The created project. Throws fault exception with error codes: Collaboration.ProjectInfoObjectRequired, Collaboration.CouldNotLoadNodeSDO, Collaboration.ProjectIDMustNotBePreset, Collaboration.CreatedByValueMustNotBePreset, Collaboration.UnableToGetParent.

      • createTask

        public Node createTask​(TaskInfo taskInfo)
        Creates a new task.
        Parameters:
        taskInfo - The creation information for the task.
        Returns:
        The created task. Throws fault exception with error codes: Collaboration.CouldNotLoadNodeSDO, Collaboration.TaskInfoObjectRequired, Collaboration.UnableToGetParent.

      • createTaskGroup

        public Node createTaskGroup​(TaskGroupInfo taskGroupInfo)
        Creates a new task group.
        Parameters:
        taskGroupInfo - The creation information for the task group.
        Returns:
        The created task group. Throws fault exception with error codes: Collaboration.CouldNotLoadNodeSDO, Collaboration.TaskGroupInfoObjectRequired, Collaboration.UnableToGetParent.

      • createTaskList

        public Node createTaskList​(TaskListInfo taskListInfo)
        Creates a new task list.
        Parameters:
        taskListInfo - The creation information for the task list.
        Returns:
        The created task list. Throws fault exception with error codes: Collaboration.CouldNotLoadNodeSDO, Collaboration.TaskListInfoObjectRequired, Collaboration.UnableToGetParent.

      • getChannel

        public ChannelInfo getChannel​(long channelID)
        Gets a channel.
        Parameters:
        channelID - The ID of the channel.
        Returns:
        A channel. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getDiscussion

        public DiscussionInfo getDiscussion​(long discussionID)
        Gets a discussion.
        Parameters:
        discussionID - The ID of the discussion.
        Returns:
        A discussion. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getMilestone

        public MilestoneInfo getMilestone​(long milestoneID)
        Gets a milestone.
        Parameters:
        milestoneID - The ID of the milestone.
        Returns:
        A milestone. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getMyAssignments

        public Assignment[] getMyAssignments()
        Gets the assignments for the current user.
        Returns:
        A list of assignments. Throws fault exception with error codes: Collaboration.Error.

      • getMyChannels

        public ChannelInfo[] getMyChannels()
        Gets all channels the current user can see.
        Returns:
        A list of channels. Throws fault exception with error codes: Collaboration.Error.

      • getMyDiscussions

        public DiscussionInfo[] getMyDiscussions()
        Gets all discussions the current user can see.
        Returns:
        A list of discussions. Throws fault exception with error codes: Collaboration.Error.

      • getMyProjects

        public ProjectInfo[] getMyProjects()
        Gets all projects the current user can see.
        Returns:
        A list of projects. Throws fault exception with error codes: Collaboration.FailedToGetProjects.

      • getMyTaskLists

        public TaskListInfo[] getMyTaskLists()
        Gets all task lists the current user can see.
        Returns:
        A list of task lists. Throws fault exception with error codes: Collaboration.FailedToGetTaskLists.

      • getNews

        public NewsInfo getNews​(long newsID)
        Gets a news item.
        Parameters:
        newsID - The ID of the news item.
        Returns:
        A news item. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getParticipants

        public ProjectParticipants getParticipants​(long projectID)
        Gets project participants.
        Parameters:
        projectID - The ID of the project.
        Returns:
        The project participants. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.FailedToFindProjectParticipants.

      • getProject

        public ProjectInfo getProject​(long projectID)
        Gets a project.
        Parameters:
        projectID - The ID of the project.
        Returns:
        A project. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getReadList

        public DiscussionReadList[] getReadList​(long discussionID)
        Gets the read list of a discussion for the current user.
        Parameters:
        discussionID - The ID of the discussion.
        Returns:
        The read list. The read list is a list containing DiscussionReadList. Each DiscussionReadList represents a range of topics/replies that were read. The ID in the list is the topic/reply internal ID, not the global data ID. Throws fault exception with error codes: Collaboration.InvalidDiscussionID.

      • getReplyByName

        public ReplyInfo getReplyByName​(long topicReplyID,
                                java.lang.String name)
        Gets a reply by its name.
        Parameters:
        topicReplyID - The ID of the parent of the reply. It can be either a topic ID or a reply ID.
        name - The name of the reply.
        Returns:
        A reply if found, null otherwise. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.InvalidName, .Collaboration.UnableToGetParent, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getTask

        public TaskInfo getTask​(long taskID)
        Gets a task.
        Parameters:
        taskID - The ID of the task.
        Returns:
        A task. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getTaskGroup

        public TaskGroupInfo getTaskGroup​(long taskGroupID)
        Gets a task group.
        Parameters:
        taskGroupID - The ID of the task group.
        Returns:
        A task group. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getTaskList

        public TaskListInfo getTaskList​(long taskListID)
        Gets a task list.
        Parameters:
        taskListID - The ID of the task list.
        Returns:
        A task list. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getTopicByName

        public TopicInfo getTopicByName​(long discussionID,
                                java.lang.String name)
        Gets a topic by its name.
        Parameters:
        discussionID - The ID of the discussion the topic is in.
        name - The name of the topic.
        Returns:
        A topic if found, null otherwise. Throws fault exception with error codes: Collaboration.ObjectIDInvalid, Collaboration.InvalidName, .Collaboration.UnableToGetParent, Collaboration.CouldNotGetObject, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getTopicReply

        public DiscussionItem getTopicReply​(long ID)
        Gets a topic or reply.
        Parameters:
        ID - The ID of the topic or reply.
        Returns:
        A topic or reply. Throws fault exception with codes: Collaboration.InvalidObjectID, Collaboration.ObjectFoundWasNotOfExpectedType.

      • getUnreadInfo

        public UnreadInfo[] getUnreadInfo​(long[] ids)
        Gets the unread information of a list of discussions for the current user.
        Parameters:
        ids - A list of discussion IDs.
        Returns:
        The unread information for the discussions. Throws fault exception with codes: Collaboration.Error.

      • listMilestones

        public MilestoneInfo[] listMilestones​(long ID)
        Gets the milestones in a task list.
        Parameters:
        ID - The ID of the task list.
        Returns:
        A list of milestones. Throws fault exception with codes: Collaboration.Error.

      • listNews

        public NewsInfo[] listNews​(long channelID)
        Gets the news items in a channel.
        Parameters:
        channelID - The ID of the channel.
        Returns:
        A list of news items. Throws fault exception with codes: Collaboration.ObjectIDInvalid, Collaboration.Error.

      • listReplies

        public ReplyInfo[] listReplies​(long topicReplyID)
        Gets the replies to a topic or reply.
        Parameters:
        topicReplyID - The ID of a topc or reply.
        Returns:
        A list of replies. Throws fault exception with codes: Collaboration.ObjectIDInvalid, Collaboration.Error.

      • listTaskGroups

        public TaskGroupInfo[] listTaskGroups​(long ID)
        Gets the task groups in a task list or task group.
        Parameters:
        ID - The ID of the task list or task group.
        Returns:
        A list of task groups. Throws fault exception with codes: Collaboration.Error.

      • listTasks

        public TaskInfo[] listTasks​(long ID)
        Gets the tasks in a task list or task group.
        Parameters:
        ID - The ID of the task list or task group.
        Returns:
        A list of tasks. Throws fault exception with codes: Collaboration.UnableToGetParent, Collaboration.Error.

      • listTopics

        public TopicInfo[] listTopics​(long discussionID)
        Gets the topics in a discussion.
        Parameters:
        discussionID - The ID of the discussion.
        Returns:
        A list of topics. Throws fault exception with codes: Collaboration.ObjectIDInvalid, Collaboration.Error.

      • postReply

        public ReplyInfo postReply​(long topicReply,
                           java.lang.String subject,
                           java.lang.String comments,
                           java.lang.Long livelinkAttachment,
                           Attachment attach)
        Posts a reply to a topic or reply.
        Parameters:
        topicReply - The ID of the parent topic or reply.
        subject - The subject of the reply.
        comments - The comments (message) of the reply.
        livelinkAttachment - The ID of a document to be attached to the reply.
        fileAtts - The description of a desktop document to be attached to the reply.
        inStream - The file stream of the desktop attachment.
        Returns:
        The created reply.

      • postTopic

        public TopicInfo postTopic​(long discussionID,
                           java.lang.String subject,
                           java.lang.String comments,
                           java.lang.Long livelinkAttachment,
                           Attachment attach)
        Posts a topic to a discussion.
        Parameters:
        discussionID - The ID of the parent discussion.
        subject - The subject of the topic.
        comments - The comments (message) of the topic.
        livelinkAttachment - The ID of a document to be attached to the topic.
        fileAtts - The description of a desktop document to be attached to the topic.
        inStream - The file stream of the desktop attachment.
        Returns:
        The created topic.

      • setReadList

        public DiscussionReadList[] setReadList​(long discussionID,
                                        DiscussionReadList[] readList)
        Sets the read list of a discussion for the current user.
        Parameters:
        discussionID - The ID of the discussion.
        readList - The read list to be set.
        Returns:
        The read list that is set. The read list is a list containing DiscussionReadList. Each DiscussionReadList represents a range of topics/replies that were read. The ID in the list is the topic/reply internal ID, not the global data ID.

      • updateMilestone

        public void updateMilestone​(MilestoneInfo milestoneInfo)
        Updates a milestone.
        Parameters:
        milestoneInfo - The update information for the milestone.

      • updateNews

        public void updateNews​(NewsInfo newsInfo)
        Updates a news item.
        Parameters:
        newsInfo - The update information for the news item.

      • updateProject

        public void updateProject​(ProjectInfo projectInfo)
        Updates a project.
        Parameters:
        projectInfo - The update information for the project.

      • updateProjectParticipants

        public void updateProjectParticipants​(long projectID,
                                      ProjectRoleUpdateInfo[] roleUpdateInfo)
        Updates the roles assigned to project participants, including removing them from a role.
        Parameters:
        projectID - The ID of the project.
        roleUpdateInfo - The list of updates to make.

      • updateTask

        public void updateTask​(TaskInfo taskInfo)
        Updates a task.
        Parameters:
        taskInfo - The update information for the task.

      • updateTaskGroup

        public void updateTaskGroup​(TaskGroupInfo taskGroupInfo)
        Updates a task group.
        Parameters:
        taskGroupInfo - The update information for the task group.