com.ibm.commerce.tickler.beans

Class TicklerListDataBean

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • TicklerListDataBean

        public TicklerListDataBean()

    • Method Detail

      • getLength

        public int getLength()
        This method gets the length of the List.
        Returns:
        the list size

      • getSortingAttribute

        public com.ibm.commerce.base.util.SortingAttribute getSortingAttribute()
        This method gets the sorting attribute.
        Returns:
        the sorting attribute

      • setSortingAttribute

        public void setSortingAttribute(com.ibm.commerce.base.util.SortingAttribute newSortAtt)
        This method sets the sorting attribute.
        Parameters:
        newSortAtt - new sorting attribute

      • getTicklerList

        public TicklerDataBean[] getTicklerList()
        This method gets the list of ticklers. A tickler reminds a Customer Service Supervisor or Customer Service Representative to perform an action.
        Specified by:
        getTicklerList in interface TicklerListSmartDataBean
        Returns:
        list of ticklers

      • setTicklerList

        public void setTicklerList(TicklerDataBean[] newListDataBean)
        This method sets the list of ticklers. A tickler reminds a Customer Service Supervisor or Customer Service Representative to perform an action.
        Specified by:
        setTicklerList in interface TicklerListInputDataBean
        Parameters:
        newListDataBean - list of ticklers

      • getDataBeanKeyResponsibleMemberId

        public java.lang.String getDataBeanKeyResponsibleMemberId()
        This method gets the ID of the responsible Customer Service Supervisor or Customer Service Representative team. Identifier of the responsible member who should act on this to-do item.
        Specified by:
        getDataBeanKeyResponsibleMemberId in interface TicklerListSmartDataBean
        Returns:
        ID of the Customer Service Supervisor or Customer Service Representative team

      • setDataBeanKeyResponsibleMemberId

        public void setDataBeanKeyResponsibleMemberId(java.lang.String newResponsibleMemberId)
        This method sets the ID of the responsible Customer Service Supervisor or Customer Service Representative team. Identifier of the responsible member who should act on this to-do item.
        Specified by:
        setDataBeanKeyResponsibleMemberId in interface TicklerListInputDataBean
        Parameters:
        newResponsibleMemberId - ID of the Customer Service Supervisor or Customer Service Representative team

      • getUserId

        public java.lang.String getUserId()
        This method gets the ID of the Customer Service Representative.
        Specified by:
        getUserId in interface TicklerListSmartDataBean
        Returns:
        ID of the Customer Service Representative

      • setUserId

        public void setUserId(java.lang.String newUserId)
        This method sets the ID of the Customer Service Representative.
        Specified by:
        setUserId in interface TicklerListInputDataBean
        Parameters:
        newUserId - ID of the Customer Service Representative

      • getStatusList

        public java.lang.String[] getStatusList()
        This method gets the status list of the ticklers. A tickler reminds a Customer Service Supervisor or Customer Service Representative to perform an action.
        Specified by:
        getStatusList in interface TicklerListSmartDataBean
        Returns:
        status list of the ticklers

      • setStatusList

        public void setStatusList(java.lang.String[] newStatusList)
        This method sets the status list of the ticklers. A tickler reminds a Customer Service Supervisor or Customer Service Representative to perform an action.
        Specified by:
        setStatusList in interface TicklerListInputDataBean
        Parameters:
        newStatusList - status list of the ticklers.

      • getStoreIds

        public java.lang.String[] getStoreIds()
        This method gets the IDs of the tickler store.
        Specified by:
        getStoreIds in interface TicklerListSmartDataBean
        Returns:
        IDs of the tickler store.

      • setStoreIds

        public void setStoreIds(java.lang.String[] newStoreIds)
        This method sets the IDs of the tickler store.
        Specified by:
        setStoreIds in interface TicklerListInputDataBean
        Parameters:
        newStoreIds - IDs of the tickler store.

      • getActionObjectTypes

        public java.lang.String[] getActionObjectTypes()
        This method gets the action object types on search type option. The action object types are the types of object to which to-do item is associated. Valid values are as follows: 
         ORDER=Order
 QUOTE=Quote
 RMA=Return
 USER=Customer
        Specified by:
        getActionObjectTypes in interface TicklerListSmartDataBean
        Returns:
        the tickler action object types.

      • setActionObjectTypes

        public void setActionObjectTypes(java.lang.String[] newActionObjectTypes)
        This method set the action object types of the tickler. The action object types are the types of object to which to-do item is associated. Valid values are as follows: 
         ORDER=Order
 QUOTE=Quote
 RMA=Return
 USER=Customer
        Specified by:
        setActionObjectTypes in interface TicklerListInputDataBean
        Parameters:
        newActionObjectTypes - action object types

      • getResponsibleMemberIds

        public java.lang.String[] getResponsibleMemberIds()
        This method gets the IDs of the responsible Customer Service Supervisor or Customer Service Representative team. Identifier of the responsible member who should act on this to-do item.
        Specified by:
        getResponsibleMemberIds in interface TicklerListSmartDataBean
        Returns:
        IDs of the Customer Service Supervisor or Customer Service Representative team

      • setResponsibleMemberIds

        public void setResponsibleMemberIds(java.lang.String[] newResponsibleMemberIds)
        This method sets the IDs of the responsible Customer Service Supervisor or Customer Service Representative team. Identifier of the responsible member who should act on this to-do item.
        Specified by:
        setResponsibleMemberIds in interface TicklerListInputDataBean
        Parameters:
        newResponsibleMemberIds - IDs of the Customer Service Supervisor or Customer Service Representative team

      • getNextTickleDateSD

        public java.sql.Timestamp getNextTickleDateSD()
        This method gets the reminder on start time of the tickler.
        Specified by:
        getNextTickleDateSD in interface TicklerListSmartDataBean
        Returns:
        The remind on start time.

      • setNextTickleDateSD

        public void setNextTickleDateSD(java.sql.Timestamp newNextTickleDateSD)
        This method sets the reminder on start time of the tickler.
        Specified by:
        setNextTickleDateSD in interface TicklerListInputDataBean
        Parameters:
        newNextTickleDateSD - The remind on start time.

      • getNextTickleDateED

        public java.sql.Timestamp getNextTickleDateED()
        This method gets the reminder on end time of the tickler.
        Specified by:
        getNextTickleDateED in interface TicklerListSmartDataBean
        Returns:
        The remind on start time.

      • setNextTickleDateED

        public void setNextTickleDateED(java.sql.Timestamp newNextTickleDateED)
        This method sets the reminder on end time of the tickler.
        Specified by:
        setNextTickleDateED in interface TicklerListInputDataBean
        Parameters:
        newNextTickleDateED - The remind on end time.

      • getCustomerId

        public java.lang.String getCustomerId()
        This method gets the primary ID of the customer.
        Returns:
        customer ID

      • setCustomerId

        public void setCustomerId(java.lang.String customerId)
        This method sets the primary ID of the customer.
        Parameters:
        customerId - customer ID

      • getTicklerId

        public java.lang.String getTicklerId()
        This method gets the tickler ID. Tickler id is the unique number to identify the to-do item.
        Returns:
        tickler ID

      • setTicklerId

        public void setTicklerId(java.lang.String ticklerId)
        This method sets the tickler ID. Tickler id is the unique number to identify the to-do item.
        Parameters:
        ticklerId - tickler ID

      • getOrderBy

        public java.lang.String getOrderBy()
        This method gets the sorting parameter of the tickler list.
        Returns:
        The list sorting parameter.

      • setOrderBy

        public void setOrderBy(java.lang.String newOrderBy)
        This method sets the sorting parameter of the tickler list.
        Parameters:
        newOrderBy - The list sorting parameter.

      • setInitialPosition

        public void setInitialPosition(int initialPosition)
        This method sets the initial position of the cursor.
        Parameters:
        initialPosition - initial position of the cursor

      • setSize

        public void setSize(int size)
        This method sets the number of records to retrieve.
        Parameters:
        size - size

      • getRowCount

        public int getRowCount()
        This method gets the number of total records.
        Returns:
        the number of total records

      • setRequestProperties

        public void setRequestProperties(TypedProperty param)
                          throws java.lang.Exception
        Copies the input parameters supplied as a TypedProperty and sets the Customer Service Supervisor or Customer Service Representative team ID. The Customer Service Supervisor or Customer Service Representative team ID is set to the value of the assignToMemberId request parameter if the Customer Service Supervisor or Customer Service Representative team ID has not already been set and the assignToMemberId request parameter is present.
        Specified by:
        setRequestProperties in interface InputDataBean
        Overrides:
        setRequestProperties in class InputDataBeanImpl
        Parameters:
        param - request parameters
        Throws:
        java.lang.Exception

      • populate

        public void populate()
              throws java.lang.Exception
        This method fetches the list of responsible ticklers.

        If the method setDataBeanKeyResponsibleMemberId is called before to set the ID of the responsible Customer Service Supervisor or Customer Service Representative team, this method will construct the list of TicklerDataBean based on the pre-set responsible Customer Service Representative ID or team. Otherwise, this method will get the IDs of ticklers that the representative can access and meet the given search criteria. These tickler IDs will be used to construct the list of TicklerDataBean which can be retrieved by calling the method getTicklerList.

        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception - thrown on any access bean error
        See Also:
        setDataBeanKeyResponsibleMemberId(java.lang.String), getTicklerList()

      • isSupervisor

        public boolean isSupervisor(java.util.List roles)
                     throws java.lang.Exception
        This method will determines if the user has Customer Service Supervisor role or not.
        Parameters:
        roles - The roles of the Representative on the tickler store
        Returns:
        true if the user has Customer Service Supervisor role
        Throws:
        java.lang.Exception

      • isRepresentative

        public boolean isRepresentative(java.util.List roles)
                         throws java.lang.Exception
        This method determines if the user has Customer Service Representative role or not.
        Parameters:
        roles - The customer representative roles of the service representative on the tickler store
        Returns:
        true if the user has Customer Service Representative role
        Throws:
        java.lang.Exception

      • isResponsibleForTickler

        public boolean isResponsibleForTickler(TicklerAccessBean ticklerBean,
                                       java.lang.String repId,
                                       java.util.List roles)
                                throws java.lang.Exception
        This method determines if the user is responsible for the tickler or not.
        Parameters:
        ticklerBean - The tickler
        repId - ID of the user
        roles - The roles of the service representative on the tickler store
        Returns:
        true if the user is responsible for the tickler
        Throws:
        java.lang.Exception
Skip navigation links