*** This class provides Binary Compatibility only, not Source Compatibility ***
Package com.sas.services.storedprocess
Class SASLog
java.lang.Object
com.sas.services.storedprocess.SASLog
- All Implemented Interfaces:
Serializable
@SASScope("ALL")
@BinaryCompatibilityOnly
public class SASLog
extends Object
implements Serializable
A collection of SAS log or listing lines. There are three components to each line: the
line text, the line type and the carriage control associated with the line.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final int -
Method Summary
Modifier and TypeMethodDescriptionint[]Returns the array of carriage control values.String[]getLines()Returns the array of lines (text).intReturns the number of lines lines that are available in this object, which is the number of elements in the arrays returned bygetLines(),getLineTypes()andgetCarriageControls().intReturns the number of lines that were requested in the call to theExecution2Interfacemethod which created this object.int[]Returns the array of line types.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
LINE_TYPE_NORMAL
public static final int LINE_TYPE_NORMAL- See Also:
-
LINE_TYPE_HIGHLIGHTED
public static final int LINE_TYPE_HIGHLIGHTED- See Also:
-
LINE_TYPE_SOURCE
public static final int LINE_TYPE_SOURCE- See Also:
-
LINE_TYPE_TITLE
public static final int LINE_TYPE_TITLE- See Also:
-
LINE_TYPE_BYLINE
public static final int LINE_TYPE_BYLINE- See Also:
-
LINE_TYPE_FOOTNOTE
public static final int LINE_TYPE_FOOTNOTE- See Also:
-
LINE_TYPE_ERROR
public static final int LINE_TYPE_ERROR- See Also:
-
LINE_TYPE_WARNING
public static final int LINE_TYPE_WARNING- See Also:
-
LINE_TYPE_NOTE
public static final int LINE_TYPE_NOTE- See Also:
-
LINE_TYPE_MESSAGE
public static final int LINE_TYPE_MESSAGE- See Also:
-
CARRIAGE_CONTROL_NORMAL
public static final int CARRIAGE_CONTROL_NORMAL- See Also:
-
CARRIAGE_CONTROL_NEWPAGE
public static final int CARRIAGE_CONTROL_NEWPAGE- See Also:
-
CARRIAGE_CONTROL_OVERPRINT
public static final int CARRIAGE_CONTROL_OVERPRINT- See Also:
-
CARRIAGE_CONTROL_SKIPLINE
public static final int CARRIAGE_CONTROL_SKIPLINE- See Also:
-
CARRIAGE_CONTROL_SKIPTWOLINES
public static final int CARRIAGE_CONTROL_SKIPTWOLINES- See Also:
-
-
Method Details
-
getLinesRequested
public int getLinesRequested()Returns the number of lines that were requested in the call to theExecution2Interfacemethod which created this object. If the method to get the log or listing had no parameter for the number of lines requested a -1 is returned.- Returns:
- the number of lines that were requested or -1
-
getLinesAvailable
public int getLinesAvailable()Returns the number of lines lines that are available in this object, which is the number of elements in the arrays returned bygetLines(),getLineTypes()andgetCarriageControls().- Returns:
- the number of lines that are available in this object
-
getLines
public String[] getLines()Returns the array of lines (text). There aregetLinesAvailable()elements in the array.- Returns:
- the array of lines
-
getLineTypes
public int[] getLineTypes()Returns the array of line types. There aregetLinesAvailable()elements in the array. Each value is one of the LINE_TYPE_ constants defined in this class.- Returns:
- the array of lines
-
getCarriageControls
public int[] getCarriageControls()Returns the array of carriage control values. There aregetLinesAvailable()elements in the array. Each value is one of the CARRIAGE_CONTROL_ constants defined in this class.- Returns:
- the array of lines
-