com.ibm.as400.access
Class AFPResource

java.lang.Object
  extended by com.ibm.as400.access.PrintObject
      extended by com.ibm.as400.access.AFPResource
All Implemented Interfaces:
Serializable

public class AFPResource
extends PrintObject
implements Serializable

The AFPResource class represents a system AFP resource. An instance of this class can be used to manipulate an individual IBM i AFP resource. See AFP Resource Attributes for valid attributes.

See Also:
Serialized Form

Field Summary
static String STR_FNTRSC
           
static String STR_FORMDF
           
static String STR_OVL
           
static String STR_PAGDFN
           
static String STR_PAGSEG
           
 
Fields inherited from class com.ibm.as400.access.PrintObject
ATTR_3812SCS, ATTR_ACCOUNT_CODE, ATTR_AFP, ATTR_AFP_RESOURCE, ATTR_AFPRESOURCE, ATTR_ALIGN, ATTR_ALIGNFORMS, ATTR_ALWDRTPRT, ATTR_ASCIITRANS, ATTR_ASPDEVICE, ATTR_AUTHCHCK, ATTR_AUTHORITY, ATTR_AUTOEND, ATTR_AUX_POOL, ATTR_BACK_OVERLAY, ATTR_BARCODE, ATTR_BKMGN_ACR, ATTR_BKMGN_DWN, ATTR_BKOVL_ACR, ATTR_BKOVL_DWN, ATTR_BTWNCPYSTS, ATTR_BTWNFILESTS, ATTR_CHANGES, ATTR_CHAR_ID, ATTR_CHARID, ATTR_CHR_RTT_CMDS, ATTR_CHRSET, ATTR_CHRSET_LIB, ATTR_CHRSET_SIZE, ATTR_CODEDFNT, ATTR_CODEDFNTLIB, ATTR_CODEDFONT_SIZE, ATTR_CODEPAGE, ATTR_CODEPAGE_NAME, ATTR_CODEPAGE_NAME_LIB, ATTR_CODFNT_ARRAY, ATTR_COLOR, ATTR_CONSTBCK_OVL, ATTR_CONTROLCHAR, ATTR_CONVERT_LINEDATA, ATTR_COPIES, ATTR_COPIESLEFT, ATTR_CORNER_STAPLE, ATTR_CPI, ATTR_CPI_CHANGES, ATTR_CURPAGE, ATTR_DATA_QUEUE, ATTR_DATAFORMAT, ATTR_DATE, ATTR_DATE_END, ATTR_DATE_USED, ATTR_DATE_WTR_BEGAN_FILE, ATTR_DATE_WTR_CMPL_FILE, ATTR_DAYS_UNTIL_EXPIRE, ATTR_DBCS_FNT, ATTR_DBCS_FNT_LIB, ATTR_DBCS_FNT_SIZE, ATTR_DBCSCPI, ATTR_DBCSDATA, ATTR_DBCSEXTENSN, ATTR_DBCSROTATE, ATTR_DBCSSISO, ATTR_DDS, ATTR_DECIMAL_FMT, ATTR_DELETESPLF, ATTR_DESCRIPTION, ATTR_DESTINATION, ATTR_DESTOPTION, ATTR_DEVCLASS, ATTR_DEVMODEL, ATTR_DEVSTATUS, ATTR_DEVTYPE, ATTR_DFR_WRITE, ATTR_DISPLAYANY, ATTR_DOUBLEWIDE, ATTR_DRAWERCHANGE, ATTR_DRWRSEP, ATTR_DUPLEX, ATTR_EDGESTITCH_NUMSTAPLES, ATTR_EDGESTITCH_REF, ATTR_EDGESTITCH_REFOFF, ATTR_ENDPAGE, ATTR_ENDPNDSTS, ATTR_ENVLP_SOURCE, ATTR_EXPIRATION_DATE, ATTR_FIDELITY, ATTR_FIELD_OUTLIN, ATTR_FILESEP, ATTR_FOLDREC, ATTR_FONT_CHANGES, ATTR_FONTID, ATTR_FONTRESFMT, ATTR_FORM_DEFINITION, ATTR_FORMFEED, ATTR_FORMTYPE, ATTR_FORMTYPEMSG, ATTR_FRONT_OVERLAY, ATTR_FTMGN_ACR, ATTR_FTMGN_DWN, ATTR_FTOVL_ACR, ATTR_FTOVL_DWN, ATTR_GRAPHICS, ATTR_GRAPHICS_TOK, ATTR_GRPLVL_IDXTAG, ATTR_HELDSTS, ATTR_HIGHLIGHT, ATTR_HOLD, ATTR_HOLDPNDSTS, ATTR_HOLDTYPE, ATTR_IMGCFG, ATTR_INTERNETADDR, ATTR_IPDSPASSTHRU, ATTR_IPP_ATTR_CCSID, ATTR_IPP_ATTR_NL, ATTR_IPP_JOB_ID, ATTR_IPP_JOB_NAME, ATTR_IPP_JOB_NAME_NL, ATTR_IPP_JOB_ORIGUSER, ATTR_IPP_JOB_ORIGUSER_NL, ATTR_IPP_PRINTER_NAME, ATTR_JOBCCSID, ATTR_JOBNAME, ATTR_JOBNUMBER, ATTR_JOBSEPRATR, ATTR_JOBSYSTEM, ATTR_JOBUSER, ATTR_JUSTIFY, ATTR_LASTPAGE, ATTR_LIBRARY, ATTR_LINESPACING, ATTR_LPI, ATTR_LPI_CHANGES, ATTR_MAX_JOBS_PER_CLIENT, ATTR_MAXRCDS, ATTR_MEASMETHOD, ATTR_MESSAGE_QUEUE, ATTR_MFGTYPE, ATTR_MSGHELP, ATTR_MSGID, ATTR_MSGREPLY, ATTR_MSGSEV, ATTR_MSGTEXT, ATTR_MSGTYPE, ATTR_MULTI_ITEM_REPLY, ATTR_MULTIUP, ATTR_NETWORK, ATTR_NPSCCSID, ATTR_NPSLEVEL, ATTR_NUMBYTES, ATTR_NUMBYTES_SPLF, ATTR_NUMFILES, ATTR_NUMRSC_LIB_ENT, ATTR_NUMWRITERS, ATTR_OBJEXTATTR, ATTR_OFFICEVISION, ATTR_ONJOBQSTS, ATTR_OPCNTRL, ATTR_OPENCMDS, ATTR_ORDER, ATTR_OS4_CRT_AFP, ATTR_OUTPTY, ATTR_OUTPUT_QUEUE, ATTR_OUTPUTBIN, ATTR_OUTQSTS, ATTR_OVERALLSTS, ATTR_OVERFLOW, ATTR_PAGE_AT_A_TIME, ATTR_PAGE_DEFINITION, ATTR_PAGE_GROUPS, ATTR_PAGE_ROTATE, ATTR_PAGELEN, ATTR_PAGELVLIDXTAG, ATTR_PAGENUMBER, ATTR_PAGES, ATTR_PAGES_EST, ATTR_PAGEWIDTH, ATTR_PAGRTT, ATTR_PAPER_SOURCE_1, ATTR_PAPER_SOURCE_2, ATTR_PELDENSITY, ATTR_PGM_OPN_FILE, ATTR_PGM_OPN_LIB, ATTR_POINTSIZE, ATTR_PRINTER, ATTR_PRINTER_FILE, ATTR_PRTASSIGNED, ATTR_PRTDEVTYPE, ATTR_PRTQUALITY, ATTR_PRTSEQUENCE, ATTR_PRTTEXT, ATTR_PUBINF, ATTR_PUBINF_COLOR_SUP, ATTR_PUBINF_DS, ATTR_PUBINF_DUPLEX_SUP, ATTR_PUBINF_LOCATION, ATTR_PUBINF_PPM, ATTR_PUBINF_PPM_COLOR, ATTR_RCDFMT_DATA, ATTR_RECLENGTH, ATTR_REDUCE, ATTR_RESTART, ATTR_RMTLOCNAME, ATTR_RMTPRTQ, ATTR_RMTSYSTEM, ATTR_RPLCHAR, ATTR_RPLUNPRT, ATTR_RSC_LIB_LIST, ATTR_SADDLESTITCH_NUMSTAPLES, ATTR_SADDLESTITCH_REF, ATTR_SADDLESTITCH_STPL_OFFSEINFO, ATTR_SAVE, ATTR_SAVE_COMMAND, ATTR_SAVE_DEVICE, ATTR_SAVE_FILE, ATTR_SAVE_LABEL, ATTR_SAVE_SEQUENCE_NUMBER, ATTR_SAVE_VOLUME_FORMAT, ATTR_SAVE_VOLUME_ID, ATTR_SCHEDULE, ATTR_SCS2ASCII, ATTR_SEEKOFF, ATTR_SEEKORG, ATTR_SENDPTY, ATTR_SEPPAGE, ATTR_SPLF_AUTH_METHOD, ATTR_SPLF_CREATOR, ATTR_SPLF_RESTORED_DATE, ATTR_SPLF_RESTORED_TIME, ATTR_SPLF_SAVED_DATE, ATTR_SPLF_SAVED_TIME, ATTR_SPLF_SECURITY_METHOD, ATTR_SPLF_SIZE, ATTR_SPLF_SIZE_MULT, ATTR_SPLFNUM, ATTR_SPLFSTATUS, ATTR_SPLSCS, ATTR_SPOOL, ATTR_SPOOLFILE, ATTR_SRC_CODEPAGE, ATTR_SRCDRWR, ATTR_STARTEDBY, ATTR_STARTPAGE, ATTR_SYS_DRV_PGM, ATTR_SYSTEM, ATTR_TGT_CODEPAGE, ATTR_TIME, ATTR_TIME_END, ATTR_TIME_WTR_BEGAN_FILE, ATTR_TIME_WTR_CMPL_FILE, ATTR_TOADDRESS, ATTR_TOUSERID, ATTR_TRC1403, ATTR_UNITOFMEAS, ATTR_USER_DEFINED_OBJECT, ATTR_USER_DFN_TXT, ATTR_USER_DRIVER_PROG, ATTR_USER_TRANSFORM_PROG, ATTR_USERCMT, ATTR_USERDATA, ATTR_USERGEN_DATA, ATTR_USRDEFDATA, ATTR_USRDEFFILE, ATTR_USRDEFOPT, ATTR_USRDRVDATA, ATTR_VIEWING_FIDELITY, ATTR_VMMVSCLASS, ATTR_WORKSTATION_CUST_OBJECT, ATTR_WRTNGSTS, ATTR_WTNGDATASTS, ATTR_WTNGDEVSTS, ATTR_WTNGMSGSTS, ATTR_WTRAUTOEND, ATTR_WTREND, ATTR_WTRINIT, ATTR_WTRJOBNAME, ATTR_WTRJOBNUM, ATTR_WTRJOBSTS, ATTR_WTRJOBUSER, ATTR_WTRSTRPAGE, ATTR_WTRSTRTD
 
Constructor Summary
AFPResource()
          Constructs an AFPResource object.
AFPResource(AS400 system, String resourceName)
          Constructs an AFPResource object.
 
Method Summary
 PrintObjectInputStream getInputStream()
          Returns an input stream that can be used to read the contents of the AFP resource.
 String getName()
          Returns the name of the AFP resource.
 String getPath()
          Returns the integrated file system pathname of the AFP resource.
 void setPath(String path)
          Sets the integrated file system pathname of the AFP resource.
 
Methods inherited from class com.ibm.as400.access.PrintObject
addPropertyChangeListener, addVetoableChangeListener, getFloatAttribute, getIntegerAttribute, getSingleFloatAttribute, getSingleIntegerAttribute, getSingleStringAttribute, getStringAttribute, getSystem, removePropertyChangeListener, removeVetoableChangeListener, setSystem, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STR_FNTRSC

public static final String STR_FNTRSC
See Also:
Constant Field Values

STR_FORMDF

public static final String STR_FORMDF
See Also:
Constant Field Values

STR_OVL

public static final String STR_OVL
See Also:
Constant Field Values

STR_PAGDFN

public static final String STR_PAGDFN
See Also:
Constant Field Values

STR_PAGSEG

public static final String STR_PAGSEG
See Also:
Constant Field Values
Constructor Detail

AFPResource

public AFPResource()
Constructs an AFPResource object. The system and the integrated file system name of the AFP resource must be set later. This constructor is provided for visual application builders that support JavaBeans. It is not intended for use by application programmers.

See Also:
PrintObject.setSystem(com.ibm.as400.access.AS400), setPath(java.lang.String)

AFPResource

public AFPResource(AS400 system,
                   String resourceName)
Constructs an AFPResource object. It uses the system and resource name that identify it on that system. The system referenced by system must be at V3R7 or later to support using AFP resources.

Parameters:
system - The system on which this AFP resource exists.
resourceName - The integrated file system name of the AFP resource. The format of the resource string must be in the format of "/QSYS.LIB/libname.LIB/resourcename.type". Valid values for type include FNTRSC, FORMDF, OVL, PAGSEG, and PAGDFN.
Method Detail

getInputStream

public PrintObjectInputStream getInputStream()
                                      throws AS400Exception,
                                             AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             IOException,
                                             InterruptedException,
                                             RequestNotSupportedException
Returns an input stream that can be used to read the contents of the AFP resource.

Returns:
The input stream object that can be used to read the contents of this AFP resource.
Throws:
AS400Exception - If the system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request completed.
IOException - If an error occurs while communicating with the system.
InterruptedException - If this thread is interrupted.
RequestNotSupportedException - If the requested function is not supported because the system operating system is not at the correct level.

getName

public String getName()
Returns the name of the AFP resource.

Returns:
The name of the AFP resource.

getPath

public String getPath()
Returns the integrated file system pathname of the AFP resource.

Returns:
The integrated file system pathname of the AFP resource.

setPath

public void setPath(String path)
             throws PropertyVetoException
Sets the integrated file system pathname of the AFP resource.

Parameters:
path - The integrated file system name of the AFP resource. The format of the resource string must be in the format of "/QSYS.LIB/libname.LIB/resourcename.type". Valid values for type include FNTRSC, FORMDF, OVL, PAGSEG, and PAGDFN.
Throws:
PropertyVetoException - If the change is vetoed.