Package dev.metaschema.oscal.lib.model

Class AuthorizedPrivilege

java.lang.Object
dev.metaschema.oscal.lib.model.AuthorizedPrivilege
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Privilege", description="Identifies a specific system privilege held by the user, along with an associated description and/or rationale for the privilege.", name="authorized-privilege", moduleClass=OscalImplementationCommonModule.class) public class AuthorizedPrivilege extends Object implements dev.metaschema.core.model.IBoundObject
Identifies a specific system privilege held by the user, along with an associated description and/or rationale for the privilege.

  • Constructor Details

    • AuthorizedPrivilege

      public AuthorizedPrivilege()
      Constructs a new dev.metaschema.oscal.lib.model.AuthorizedPrivilege instance with no metadata.

    • AuthorizedPrivilege

      public AuthorizedPrivilege(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.AuthorizedPrivilege instance with the specified metadata.
      Parameters:
      data - the metaschema data, or null if none

  • Method Details

    • getMetaschemaData

      public dev.metaschema.core.model.IMetaschemaData getMetaschemaData()
      Specified by:
      getMetaschemaData in interface dev.metaschema.core.model.IBoundObject

    • getTitle

      @NonNull public dev.metaschema.core.datatype.markup.MarkupLine getTitle()
      Get the "Privilege Title".

      A human readable name for the privilege.

      Returns:
      the title value

    • setTitle

      public void setTitle(@NonNull dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "Privilege Title".

      A human readable name for the privilege.

      Parameters:
      value - the title value to set

    • getDescription

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Privilege Description".

      A summary of the privilege's purpose within the system.

      Returns:
      the description value, or null if not set

    • setDescription

      public void setDescription(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Privilege Description".

      A summary of the privilege's purpose within the system.

      Parameters:
      value - the description value to set, or null to clear

    • getFunctionsPerformed

      @NonNull public List<String> getFunctionsPerformed()
      Get the "Functions Performed".

      Describes a function performed for a given authorized privilege by this user class.

      Returns:
      the function-performed value

    • setFunctionsPerformed

      public void setFunctionsPerformed(@NonNull List<String> value)
      Set the "Functions Performed".

      Describes a function performed for a given authorized privilege by this user class.

      Parameters:
      value - the function-performed value to set

    • addFunctionPerformed

      public boolean addFunctionPerformed(String item)
      Add a new String item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeFunctionPerformed

      public boolean removeFunctionPerformed(String item)
      Remove the first matching String item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • toString

      public String toString()
      Overrides:
      toString in class Object