Package com.uc4.api

Class ObjectTypeFilter

  • Direct Known Subclasses:
    ServiceFulfillmentList.Filter, TaskFilter

    public abstract class ObjectTypeFilter
    extends java.lang.Object
    This is a abstract base class for filters which needs object types.
    • Constructor Summary

      Constructors 
      Constructor Description
      ObjectTypeFilter()
      Constructs a new TaskFilter object.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Set<java.lang.String> getOtypes()
      Gets the object types, which will be returned by the filter.
      boolean isTypeAPI()
      Returns true if Call API tasks are selected.
      boolean isTypeC_HOSTG()
      Returns true if the AgentGroup Container is selected.
      boolean isTypeC_PERIOD()  
      boolean isTypeCALL()
      Returns true if the Notification object is selected.
      boolean isTypeCAU()
      Returns true if the CAU statistics type is selected.
      boolean isTypeCBCK()
      Returns true if the callback type is selected.
      boolean isTypeCLNTDEL()
      Returns true if the client deletion type is selected.
      boolean isTypeCPIT()
      Returns true if the Cockpit object is selected.
      boolean isTypeDEPLOY()
      Returns true if the DEPLOY statistics type is selected.
      boolean isTypeEVNT()
      Returns true if the Event object is selected.
      boolean isTypeGROUP()
      Deprecated.
      Use isTypeJOBG() instead
      boolean isTypeHOSTG()
      Deprecated.
      Use isTypeC_HOSTG() instead.
      boolean isTypeJOBD()
      Returns true if child jobs are selected.
      boolean isTypeJOBF()
      Returns true if the FileTransfer object is selected.
      boolean isTypeJOBG()
      Returns true if the Group object is selected.
      boolean isTypeJOBP()
      Returns true if the JobPlan object is selected.
      boolean isTypeJOBQ()
      Returns true if the QueueManager object is selected.
      boolean isTypeJOBS()
      Returns true if the Job object is selected.
      boolean isTypeJSCH()
      Returns true if the Schedule object is selected.
      boolean isTypePERIOD()
      Deprecated.
      Use isTypeC_PERIOD() instead.
      boolean isTypePostEVNT()
      Returns true if the !Event object is selected.
      boolean isTypeREPORT()
      Returns true if the Report object is selected.
      boolean isTypeSCRI()
      Returns true if the Script object is selected.
      boolean isTypeUSER()
      Returns true if USER object is selected.
      void selectAllObjects()
      Select all object types.
      void selectTaskRelatedObjectTypes()
      Sets a filter to object types that are task related.
      void setObjectType​(java.lang.String type, boolean select)
      Sets or clears a filter for the object type.
      void setTypeAPI​(boolean typeAPI)
      Select Call APIs if the parameter typeAPI is true.
      void setTypeC_HOSTG​(boolean typeHOSTG)
      Selects the AgentGroup Container.
      void setTypeC_PERIOD​(boolean typePERIOD)
      Selects the container for periodical UC4 objects.
      void setTypeCALL​(boolean b)
      Select Notification objects.
      void setTypeCAU​(boolean b)
      Select CAU statistic entries.
      void setTypeCBCK​(boolean callback)
      Select CBCK objects if the parameter callback is true.
      void setTypeCLNTDEL​(boolean queueManager)
      Select CLNTDEL objects if the parameter queueManager is true.
      void setTypeCPIT​(boolean b)
      Select Cockpit objects.
      void setTypeDEPLOY​(boolean b)
      Select Deploy statistic entries.
      void setTypeEVNT​(boolean b)
      Select Event objects.
      void setTypeGROUP​(boolean b)
      Deprecated.
      Use the method setTypeJOBG() instead
      void setTypeHOSTG​(boolean typeHOSTG)
      Deprecated.
      Use the method setTypeC_HOSTG() instead
      void setTypeJOBD​(boolean jobd)
      Select child jobs if the parameter jobd is true.
      void setTypeJOBF​(boolean b)
      Select FileTransfer objects.
      void setTypeJOBG​(boolean b)
      Select Group objects.
      void setTypeJOBP​(boolean b)
      Select JobPlan objects.
      void setTypeJOBQ​(boolean queueManager)
      Select JOBQ objects if the parameter queueManager is true.
      void setTypeJOBS​(boolean b)
      Select Job objects.
      void setTypeJSCH​(boolean b)
      Select Schedule objects.
      void setTypePERIOD​(boolean typePERIOD)
      Deprecated.
      Use the method setTypeC_PERIOD() instead.
      void setTypePostEvnt​(boolean b)
      Select !Event objects.
      void setTypeREPORT​(boolean b)
      Select Report objects.
      void setTypeSCRI​(boolean b)
      Sets the selection for the Script object.
      void setTypeUSER​(boolean queueManager)
      Select USER objects if the parameter queueManager is true.
      void unselectAllObjects()
      Unselect all object types.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ObjectTypeFilter

        public ObjectTypeFilter()
        Constructs a new TaskFilter object.
    • Method Detail

      • selectTaskRelatedObjectTypes

        public void selectTaskRelatedObjectTypes()
        Sets a filter to object types that are task related. Use this method to exclude types of historical data which are not task related such as USER, SYNC, QUEUE, CLNT, HOST, SERV, CAU/DEPLOY, CLNTDEL
      • getOtypes

        public java.util.Set<java.lang.String> getOtypes()
        Gets the object types, which will be returned by the filter.
        Returns:
        the otypes
      • isTypeCALL

        public boolean isTypeCALL()
        Returns true if the Notification object is selected.
        Returns:
        Notification selection
      • isTypeCPIT

        public boolean isTypeCPIT()
        Returns true if the Cockpit object is selected.
        Returns:
        Cockpit selection
      • isTypeEVNT

        public boolean isTypeEVNT()
        Returns true if the Event object is selected.
        Returns:
        Event selection
      • isTypePostEVNT

        public boolean isTypePostEVNT()
        Returns true if the !Event object is selected.
        Returns:
        Event selection
      • isTypeJOBF

        public boolean isTypeJOBF()
        Returns true if the FileTransfer object is selected.
        Returns:
        FileTransfer selection
      • isTypeGROUP

        @Deprecated
        public boolean isTypeGROUP()
        Deprecated.
        Use isTypeJOBG() instead
        Returns true if the Group object is selected.
        Returns:
        Group selection
      • isTypeJOBG

        public boolean isTypeJOBG()
        Returns true if the Group object is selected.
        Returns:
        Group selection
      • isTypeJOBS

        public boolean isTypeJOBS()
        Returns true if the Job object is selected.
        Returns:
        job selection
      • isTypeCAU

        public boolean isTypeCAU()
        Returns true if the CAU statistics type is selected.
        Returns:
        CAU selection
      • isTypeDEPLOY

        public boolean isTypeDEPLOY()
        Returns true if the DEPLOY statistics type is selected.
        Returns:
        Deploy selection
      • isTypeHOSTG

        @Deprecated
        public boolean isTypeHOSTG()
        Deprecated.
        Use isTypeC_HOSTG() instead.
        Returns true if the AgentGroup Container is selected.
        Returns:
        AgentGroup Container selection
      • isTypeC_HOSTG

        public boolean isTypeC_HOSTG()
        Returns true if the AgentGroup Container is selected.
        Returns:
        AgentGroup Container selection
      • isTypePERIOD

        @Deprecated
        public boolean isTypePERIOD()
        Deprecated.
        Use isTypeC_PERIOD() instead.
        Returns:
        true if the Container for periodical objects is selected.
      • isTypeC_PERIOD

        public boolean isTypeC_PERIOD()
        Returns:
        true if the Container for periodical objects is selected.
      • isTypeJOBP

        public boolean isTypeJOBP()
        Returns true if the JobPlan object is selected.
        Returns:
        JobPlan object
      • isTypeREPORT

        public boolean isTypeREPORT()
        Returns true if the Report object is selected.
        Returns:
        report selection
      • isTypeJSCH

        public boolean isTypeJSCH()
        Returns true if the Schedule object is selected.
        Returns:
        Schedule selection
      • isTypeJOBQ

        public boolean isTypeJOBQ()
        Returns true if the QueueManager object is selected.
        Returns:
        JOBQ selection
      • isTypeAPI

        public boolean isTypeAPI()
        Returns true if Call API tasks are selected.
        Returns:
        API selection
      • isTypeSCRI

        public boolean isTypeSCRI()
        Returns true if the Script object is selected.
        Returns:
        Script selection
      • isTypeJOBD

        public boolean isTypeJOBD()
        Returns true if child jobs are selected.
        Returns:
        JOBD selection
      • isTypeUSER

        public boolean isTypeUSER()
        Returns true if USER object is selected.
        Returns:
        USER selection
      • isTypeCLNTDEL

        public boolean isTypeCLNTDEL()
        Returns true if the client deletion type is selected.
        Returns:
        CLNTDEL selection
      • isTypeCBCK

        public boolean isTypeCBCK()
        Returns true if the callback type is selected.
        Returns:
        CBCK selection
      • setTypeHOSTG

        @Deprecated
        public void setTypeHOSTG​(boolean typeHOSTG)
        Deprecated.
        Use the method setTypeC_HOSTG() instead
        Selects the AgentGroup Container.
        Parameters:
        typeHOSTG - AgentGroup Container selection
      • setTypeC_HOSTG

        public void setTypeC_HOSTG​(boolean typeHOSTG)
        Selects the AgentGroup Container.
        Parameters:
        typeHOSTG - AgentGroup Container selection
      • setTypePERIOD

        @Deprecated
        public void setTypePERIOD​(boolean typePERIOD)
        Deprecated.
        Use the method setTypeC_PERIOD() instead.
        Selects the container for periodical UC4 objects.
        Parameters:
        typePERIOD - Periodical Objects Container selection
      • setTypeC_PERIOD

        public void setTypeC_PERIOD​(boolean typePERIOD)
        Selects the container for periodical UC4 objects.
        Parameters:
        typePERIOD - Periodical Objects Container selection
      • setTypeCALL

        public void setTypeCALL​(boolean b)
        Select Notification objects.
        Parameters:
        b - Boolean value, if set to true tasks of type CALL are included in the returned list
      • setTypeCPIT

        public void setTypeCPIT​(boolean b)
        Select Cockpit objects.
        Parameters:
        b - Boolean value, if set to true tasks of type CPIT are included in the returned list
      • setTypeEVNT

        public void setTypeEVNT​(boolean b)
        Select Event objects.
        Parameters:
        b - Boolean value, if set to true tasks of type EVNT are included in the returned list
      • setTypePostEvnt

        public void setTypePostEvnt​(boolean b)
        Select !Event objects.
        Parameters:
        b - Boolean value, if set to true tasks of type !EVNT are included in the returned list
      • setTypeJOBF

        public void setTypeJOBF​(boolean b)
        Select FileTransfer objects.
        Parameters:
        b - Boolean value, if set to true tasks of type JOBF are included in the returned list
      • setTypeGROUP

        @Deprecated
        public void setTypeGROUP​(boolean b)
        Deprecated.
        Use the method setTypeJOBG() instead
        Select Group objects.
        Parameters:
        b - Boolean value, if set to true tasks of type JOBG are included in the returned list
      • setTypeJOBG

        public void setTypeJOBG​(boolean b)
        Select Group objects.
        Parameters:
        b - Boolean value, if set to true tasks of type JOBG are included in the returned list
      • setTypeJOBS

        public void setTypeJOBS​(boolean b)
        Select Job objects.
        Parameters:
        b - Boolean value, if set to true tasks of type JOBS are included in the returned list
      • setTypeCAU

        public void setTypeCAU​(boolean b)
        Select CAU statistic entries.
        Parameters:
        b - Boolean value, if set to true statistics of type CAU are included in the returned list
      • setTypeDEPLOY

        public void setTypeDEPLOY​(boolean b)
        Select Deploy statistic entries.
        Parameters:
        b - Boolean value, if set to true statistics of type Deploy are included in the returned list
      • setTypeJOBP

        public void setTypeJOBP​(boolean b)
        Select JobPlan objects.
        Parameters:
        b - Boolean value, if set to true tasks of type JOBP are included in the returned list
      • setTypeREPORT

        public void setTypeREPORT​(boolean b)
        Select Report objects.
        Parameters:
        b - Boolean value, if set to true tasks of type REPORT are included in the returned list
      • setTypeJSCH

        public void setTypeJSCH​(boolean b)
        Select Schedule objects.
        Parameters:
        b - Boolean value, if set to true tasks of type JSCH are included in the returned list
      • setTypeSCRI

        public void setTypeSCRI​(boolean b)
        Sets the selection for the Script object.
        Parameters:
        b - Boolean value, if set to true tasks of type SCRI are included in the returned list
      • setTypeJOBD

        public void setTypeJOBD​(boolean jobd)
        Select child jobs if the parameter jobd is true.
        Parameters:
        jobd - JOBD selection
      • setTypeAPI

        public void setTypeAPI​(boolean typeAPI)
        Select Call APIs if the parameter typeAPI is true.
        Parameters:
        typeAPI - API selection
      • setTypeJOBQ

        public void setTypeJOBQ​(boolean queueManager)
        Select JOBQ objects if the parameter queueManager is true.
        Parameters:
        queueManager - JOBQ selection
      • setTypeUSER

        public void setTypeUSER​(boolean queueManager)
        Select USER objects if the parameter queueManager is true.
        Parameters:
        queueManager - USER selection
      • setTypeCLNTDEL

        public void setTypeCLNTDEL​(boolean queueManager)
        Select CLNTDEL objects if the parameter queueManager is true.
        Parameters:
        queueManager - CLNTDEL selection
      • setTypeCBCK

        public void setTypeCBCK​(boolean callback)
        Select CBCK objects if the parameter callback is true.
        Parameters:
        callback - selection
      • selectAllObjects

        public void selectAllObjects()
        Select all object types.
      • unselectAllObjects

        public void unselectAllObjects()
        Unselect all object types.
      • setObjectType

        public void setObjectType​(java.lang.String type,
                                  boolean select)
        Sets or clears a filter for the object type.
        Parameters:
        type - Object type, for example "JOBS", "SCRI", "C_HOSTG"
        select - true to set the filter false to clear the filter