Package com.uc4.api.objects

Class ObjectRight

  • All Implemented Interfaces:
    Rights
    public class ObjectRight
extends java.lang.Object
implements Rights
    This class represents a row on the authorizations tab of an object.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        ObjectRight()
      Creates a new ObjectRight object.
      protected ObjectRight​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element el)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      UC4ObjectName getName()
      Returns the UC4UserName (User) or UC4ObjectName (UserGroup) for the ObjectRight.
      boolean isCancel()
      Returns the access method: Cancel.
      boolean isDefineSLA()
      Access method: Define SLA.
      boolean isDelete()
      Returns the access method: Delete.
      boolean isExecute()
      Returns the access method: Execute.
      boolean isModifyAtRuntime()
      Access method: Modify at runtime This access method permits the setting of trace options on UC4 Automation Engines or Agents and the ending of RemoteTaskManager and Event objects.
      boolean isRead()
      Returns the access method: Read.
      boolean isReport()
      Access to Reports.
      boolean isStatistics()
      Access to Statistics.
      boolean isWrite()
      Returns the access method: Write.
      protected void save​(org.w3c.dom.Element row)  
      void setCancel​(boolean cancel)
      Sets the access method: Cancel.
      void setDefineSLA​(boolean defineSLA)
      Sets the access method: Define SLA.
      void setDelete​(boolean delete)
      Sets the access method: Delete.
      void setExecute​(boolean execute)
      Sets the access method: Execute.
      void setModifyAtRuntime​(boolean modifyAtRuntime)
      Sets the access method: Modify at runtime This access method permits the setting of trace options on UC4 Automation Engines or Agents and the ending of RemoteTaskManager and Event objects.
      void setName​(UC4ObjectName name)
      Sets the name for the ObjectRight.
      void setRead​(boolean read)
      Sets the access method: Read.
      void setReport​(boolean report)
      Sets access to Reports.
      void setStatistics​(boolean statistics)
      Sets access to Statistics.
      void setWrite​(boolean write)
      Sets the access method: Write.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ObjectRight

        public ObjectRight()
        Creates a new ObjectRight object.

      • ObjectRight

        protected ObjectRight​(com.uc4.util.XMLDocument doc,
                      org.w3c.dom.Element el)

    • Method Detail

      • save

        protected void save​(org.w3c.dom.Element row)

      • isRead

        public boolean isRead()
        Description copied from interface: Rights
        Returns the access method: Read.
        Specified by:
        isRead in interface Rights
        Returns:
        true if enabled, false if disabled

      • setRead

        public void setRead​(boolean read)
        Description copied from interface: Rights
        Sets the access method: Read.
        Specified by:
        setRead in interface Rights
        Parameters:
        read - true to enable, false to disable this action

      • isWrite

        public boolean isWrite()
        Description copied from interface: Rights
        Returns the access method: Write.
        Specified by:
        isWrite in interface Rights
        Returns:
        true if enabled, false if disabled

      • setWrite

        public void setWrite​(boolean write)
        Description copied from interface: Rights
        Sets the access method: Write.
        Specified by:
        setWrite in interface Rights
        Parameters:
        write - true to enable, false to disable this action

      • isExecute

        public boolean isExecute()
        Description copied from interface: Rights
        Returns the access method: Execute.
        Specified by:
        isExecute in interface Rights
        Returns:
        true if enabled, false if disabled

      • setExecute

        public void setExecute​(boolean execute)
        Description copied from interface: Rights
        Sets the access method: Execute.
        Specified by:
        setExecute in interface Rights
        Parameters:
        execute - true to enable, false to disable this action

      • isDelete

        public boolean isDelete()
        Description copied from interface: Rights
        Returns the access method: Delete.
        Specified by:
        isDelete in interface Rights
        Returns:
        true if enabled, false if disabled

      • setDelete

        public void setDelete​(boolean delete)
        Description copied from interface: Rights
        Sets the access method: Delete.
        Specified by:
        setDelete in interface Rights
        Parameters:
        delete - true to enable, false to disable this action

      • isCancel

        public boolean isCancel()
        Description copied from interface: Rights
        Returns the access method: Cancel.
        Specified by:
        isCancel in interface Rights
        Returns:
        true if enabled, false if disabled

      • setCancel

        public void setCancel​(boolean cancel)
        Description copied from interface: Rights
        Sets the access method: Cancel.
        Specified by:
        setCancel in interface Rights
        Parameters:
        cancel - true to enable, false to disable this action

      • isStatistics

        public boolean isStatistics()
        Description copied from interface: Rights
        Access to Statistics.
        Specified by:
        isStatistics in interface Rights
        Returns:
        true if enabled, false if disabled

      • setStatistics

        public void setStatistics​(boolean statistics)
        Description copied from interface: Rights
        Sets access to Statistics.
        Specified by:
        setStatistics in interface Rights
        Parameters:
        statistics - true to enable, false to disable this action

      • isReport

        public boolean isReport()
        Description copied from interface: Rights
        Access to Reports.
        Specified by:
        isReport in interface Rights
        Returns:
        true if enabled, false if disabled

      • setReport

        public void setReport​(boolean report)
        Description copied from interface: Rights
        Sets access to Reports.
        Specified by:
        setReport in interface Rights
        Parameters:
        report - true to enable, false to disable this action

      • isModifyAtRuntime

        public boolean isModifyAtRuntime()
        Description copied from interface: Rights
        Access method: Modify at runtime This access method permits the setting of trace options on UC4 Automation Engines or Agents and the ending of RemoteTaskManager and Event objects.
        Specified by:
        isModifyAtRuntime in interface Rights
        Returns:
        true if enabled, false if disabled

      • setModifyAtRuntime

        public void setModifyAtRuntime​(boolean modifyAtRuntime)
        Description copied from interface: Rights
        Sets the access method: Modify at runtime This access method permits the setting of trace options on UC4 Automation Engines or Agents and the ending of RemoteTaskManager and Event objects.
        Specified by:
        setModifyAtRuntime in interface Rights
        Parameters:
        modifyAtRuntime - true to enable, false to disable this action

      • isDefineSLA

        public boolean isDefineSLA()
        Description copied from interface: Rights
        Access method: Define SLA.
        Specified by:
        isDefineSLA in interface Rights
        Returns:
        true if enabled, false if disabled

      • setDefineSLA

        public void setDefineSLA​(boolean defineSLA)
        Description copied from interface: Rights
        Sets the access method: Define SLA.
        Specified by:
        setDefineSLA in interface Rights
        Parameters:
        defineSLA - true to enable, false to disable this action

      • getName

        public UC4ObjectName getName()
        Returns the UC4UserName (User) or UC4ObjectName (UserGroup) for the ObjectRight.
        Returns:
        UC4ObjectName

      • setName

        public void setName​(UC4ObjectName name)
        Sets the name for the ObjectRight. For a UserName use UC4UserName, for UserGroup UC4ObjectName.
        Parameters:
        name - UC4ObjectName