src.com.ibm.as400.access.ProductDirectoryInformation Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jt400-jdk8 Show documentation
The Open Source version of the IBM Toolbox for Java
There is a newer version: 11.1
///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                              
//                                                                             
// Filename: ProductDirectoryInformation.java
//                                                                             
// The source code contained herein is licensed under the IBM Public License   
// Version 1.0, which has been approved by the Open Source Initiative.         
// Copyright (C) 1997-2001 International Business Machines Corporation and     
// others. All rights reserved.                                                
//                                                                             
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.access;

/**
 * Represents product directory information for a specific licensed product.
 * Use the {@link com.ibm.as400.access.Product#getDirectoryInformation Product.getDirectoryInformation } method
 * to retrieve the product directory information for a product.
 * @see com.ibm.as400.access.Product
**/
public class ProductDirectoryInformation
{
  private static final String copyright = "Copyright (C) 1997-2002 International Business Machines Corporation and others.";

  private String publicDataAuthority_;
  private String fullPath_;
  private String installedPath_;
  private String[] authorities_;

  ProductDirectoryInformation(String publicAuth, String fullPath, String installPath, String[] authorities)
  {
    publicDataAuthority_ = publicAuth;
    fullPath_ = fullPath;
    installedPath_ = installPath;
    authorities_ = authorities;
  }

  /**
   * The installed full path name for the product directory. This is the installed product home directory
   * concatenated with the installed product directory name.
   * @return The installed full path name of the product directory.
  **/
  public String getInstalledPath()
  {
    return installedPath_;
  }

  /**
   * The primary full path name for the product directory. This is the primary product home directory concatenated 
   * with the primary product directory name.
   * @return The primary full path name of the product directory.
  **/
  public String getPrimaryPath()
  {
    return fullPath_;
  }

  /**
   * The public data authority given to the directory by the Restore Licensed Program (RSTLICPGM) command when
   * this product is installed if the directory does not exist. If the product load has not been successfully
   * packaged, this field is blank. Other possible values are:
   * 
   * *RWX - Read, write, and execute authorities.
   * 
*RW - Read and write authorities.
   * 
*RX - Read and execute authorities.
   * 
*WX - Write and execute authorities.
   * 
*R - Read authority.
   * 
*W - Write authority.
   * 
*X - Execute authority.
   * 
*EXCLUDE - Restricted authority.
   * 
*NONE - No specific authorities.
   * 
   * @return The public data authority for this product directory.
   * @see com.ibm.as400.access.UserPermission
  **/
  public String getPublicDataAuthority() 
  {
    return publicDataAuthority_;
  }

  /**
   * The public object authorities given to the directory by the Restore Licensed Program (RSTLICPGM) command when
   * this product is installed if the directory does not exist. If the product load has not been successfully
   * packaged, the number of public object authorities will be 0 and this method will return an empty String array.
   * Possible public object authorities are:
   * 
   * *NONE - No authority.
   * 
*ALL - All authorities.
   * 
*OBJEXIST - Existence authority.
   * 
*OBJMGT - Management authority.
   * 
*OBJALTER - Alter authority.
   * 
*OBJREF - Reference authority.
   * 
   * @return The public object authorities for this product directory.
   * @see com.ibm.as400.access.UserPermission
  **/
  public String[] getPublicObjectAuthorities()
  {
    return authorities_;
  }

  /**
   * Returns the string representation of this object.
   * @return The primary full path name of this product directory.
  **/
  public String toString()
  {
    return fullPath_;
  }
}