%CSP.Routine
stream class %CSP.Routine extends %Library.FileCharacterStream
Subclass of %FileCharacterStream that is used to load, save, compile, delete, etc. CSP files. To create one you pass it the URL of the CSP file you wish to manipulate such as: Set stream=##class(%CSP.Routine).%New("/csp/samples/inspector.csp")
Do stream.OutputToDevice()
Property Inventory
Method Inventory
- Clear()
- ClearGatewayCache()
- Compile()
- Delete()
- Exists()
- GetCurrentTimeStamp()
- GetDate()
- LinkToUrl()
- Lock()
- LockRoutine()
- OpenStream()
- SaveStream()
- Unlock()
- UpToDateGet()
Parameters
parameter FILEEXT = csp;
Override of file extension from %FileCharacterStream.
Properties
property Generated as %Boolean;
True if this routine is generated from something else
Property methods: GeneratedDisplayToLogical(), GeneratedGet(), GeneratedIsValid(), GeneratedLogicalToDisplay(), GeneratedNormalize(), GeneratedSet()
property IsModified as %Boolean [ InitialExpression = 0 ];
Property methods: IsModifiedDisplayToLogical(), IsModifiedGet(), IsModifiedIsValid(), IsModifiedLogicalToDisplay(), IsModifiedNormalize(), IsModifiedSet()
property Locked as %Integer [ InitialExpression = 0 ];
Number of times this routines has been locked.
Property methods: LockedDisplayToLogical(), LockedGet(), LockedIsValid(), LockedLogicalToDisplay(), LockedNormalize(), LockedSet()
property Namespace as %String;
Readonly property holding the namespace for this CSP application.
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize()
property TimeStamp as %TimeStamp [ Calculated ];
Caclulated property that contains the current timestamp for the routine.
Property methods: TimeStampDisplayToLogical(), TimeStampIsValid(), TimeStampLogicalToDisplay(), TimeStampNormalize(), TimeStampOdbcToLogical()
property UpToDate as %Boolean [ Calculated ];
Property methods: UpToDateDisplayToLogical(), UpToDateIsValid(), UpToDateLogicalToDisplay(), UpToDateNormalize()
property Url as %String;
Property holding the URL for this CSP application.
Property methods: UrlDisplayToLogical(), UrlGet(), UrlIsValid(), UrlLogicalToDisplay(), UrlLogicalToOdbc(), UrlNormalize()
Methods
Inherited description: Clear the contents of this Stream from permanent storage. This will remove the permanent stream storage and
any temporary stream and initialise the stream to its initial state that it starts in, including removing all
the stream attributes.
Returns a %Status value indicating success or failure.
If needed this will clear the gateway cache of this static url
Compile this CSP page. This calls SaveStream() to flush the stream
out to disk before calling compile.
Delete the file associated with this CSP url
Return true if the CSP file exists (not the class) and false otherwise.
method GetCurrentTimeStamp() as %TimeStamp
Get the timestamp for the routine.
classmethod GetDate(url As %String) as %TimeStamp
Return the timestamp of this CSP/CSR file. If there is no file then return -1
Link this stream to the file pointed to by this url.
method Lock() as %Status
Lock the current routine
classmethod LockRoutine(name As %String, lock As %Boolean = 1, checkfile As %Boolean = 1) as %Status
Lock or unlock a particular routine name. If lock
is true then it will be locked else it will be unlocked.
Override of OpenStream method from %FileCharacterStream to open a %CSP.Routine.
Override of SaveStream method from %FileCharacterStream to save this stream
method Unlock() as %Status
Unlock the current routine
method UpToDateGet() as %Boolean
Inherited Members
Inherited Properties
- %Location
- AtEnd
- Attributes
- BOM
- CanonicalFilename
- Directory
- Filename
- Id
- LastModified
- LineTerminator
- ReadSize
- RemoveOnClose
- Size
- StreamFormatWrite
- TranslateTable
Inherited Methods
- %AddToSaveSet()
- %CheckUnique()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %LOBPrefetch()
- %LocationGet()
- %LocationSet()
- %LockStream()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %ObjectSize()
- %Oid()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %ReleaseLock()
- %Reload()
- %RemoveFromSaveSet()
- %RollBack()
- %Save()
- %SerializeObject()
- %SetModified()
- %UnlockStream()
- %ValidateObject()
- CanonicalFilenameGet()
- CopyFrom()
- CopyFromAndSave()
- DeleteAttribute()
- DeleteStream()
- FileBinarySize()
- FilenameGet()
- FilenameSet()
- FindAt()
- Flush()
- GetAttribute()
- GetAttributeList()
- GetStreamId()
- GetStreamIdForFile()
- InputFromDevice()
- IsCharacter()
- IsDefinedAttribute()
- IsFileUnicode()
- IsNull()
- LastModifiedGet()
- LineTerminatorSet()
- LinkToFile()
- MoveTo()
- MoveToEnd()
- NewFileName()
- NextAttribute()
- OutputToDevice()
- OutputToDeviceAt()
- Read()
- ReadLine()
- ReadLineIntoStream()
- ReadSQL()
- Rewind()
- SerializeToSyncSet()
- SetAttribute()
- SetAttributeList()
- SizeGet()
- StreamOIDIsNull()
- SyncStreamIn()
- TranslateTableSet()
- Write()
- WriteLine()