RcodeInfo.java
/*
** Module : RcodeInfo.java
** Abstract : Interface for accessing properties of a specific ABL r-code file.
**
** Copyright (c) 2017-2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------- Description --------------------------------------
** 001 SVL 20170126 Created initial version.
** 002 EVL 20190426 Adding CODEPAGE attribute getter.
** 003 CA 20190530 Added IS-CLASS stub.
** 004 CA 20210527 Added runtime support.
** CA 20220426 Added TABLE-LIST.
** CA 20220428 Added LegacyResource annotation.
** IAS 20221129 Added stubs for missed RCODE-INFO attributes.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.util;
/**
* Interface for accessing properties of a specific ABL r-code file.
*/
@LegacyResource(resource = LegacyResource.RCODE_INFO)
public interface RcodeInfo
extends CommonFile,
CommonHandle
{
/**
* Get the list of the databases, referenced by the r-code file.
*
* @return comma-separated list of the databases (in the form of logical database names),
* referenced by the r-code file.
*/
@LegacyAttribute(name = "DB-REFERENCES")
public character getDbReferences();
/**
* Definition of the IS-CLASS method.
*
* @return <code>true</code> if the current program is a NEW-ly created object.
*/
@LegacyAttribute(name = "IS-CLASS")
public logical isClass();
/**
* Get the CODEPAGE attribute referenced by the target r-code file.
*
* @return The current CODEPAGE attribute for handle referenced by the target r-code file.
*/
@LegacyAttribute(name = "CODEPAGE")
public default character getCodePage()
{
return I18nOps.getCodePage();
}
/**
* Get the list of the tables, referenced by the r-code file.
*
* @return comma-separated list of the tables (in the form of <code>schema.table</code>),
* referenced by the r-code file.
*/
@LegacyAttribute(name = "TABLE-LIST")
public character getTableList();
/**
* Get a comma-separated list of the CRC value for each table referenced in the r-code file.
* @return a comma-separated list of the CRC value for each table referenced in the r-code file.
*/
@LegacyAttribute(name = "TABLE-CRC-LIST")
public default character getTableCrcList()
{
// TODO: implement
return new character();
}
/**
* Get the cyclic redundancy check (CRC) value for an r-code file.
* @return the cyclic redundancy check (CRC) value for an r-code file/
*/
@LegacyAttribute(name = "CRC-VALUE")
public default character getCrcVal()
{
// TODO: implement
return new character();
}
/**
* Get the type of display for an r-code file.
* @return the type of display for an r-code file.
*/
@LegacyAttribute(name = "DISPLAY-TYPE")
public default character getRCodeDisplayType()
{
// TODO: implement
return new character();
}
/**
* Check whether the r-code was compiled with the -nocolon startup parameter in effect.
*
* @return <code>true</code> if the r-code was compiled with the -nocolon startup parameter in effect.
*/
@LegacyAttribute(name = "LABELS-HAVE-COLONS")
public default logical isLabelsHaveColons()
{
// TODO: implement
return new logical();
}
/**
* Get a comma-separated list of all languages compiled into the r-code file.
*
* @return a comma-separated list of all languages compiled into the r-code file.
*/
@LegacyAttribute(name = "LANGUAGES")
public default character getLanuages()
{
// TODO: implement
return new character();
}
/**
* Get the MD5 value stored in an r-code file.
*
* @return the MD5 value stored in an r-code file as a 32 character hexadecimal number.
*/
@LegacyAttribute(name = "MD5-VALUE")
public default character getMD5Val()
{
// TODO: implement
return new character();
}
/**
* Check if UNDO, THROW has been set as the default error handling directive at either the
* routine level or the block level
*
* @return "ROUTINE-LEVEL", or "BLOCK-LEVEL" to indicate which blocks are affected by UNDO,
* THROW error handling. It returns the empty string ("") when default error handling
* is in effect
*/
@LegacyAttribute(name = "UNDO-THROW-SCOPE")
public default character getUndoThrowScope()
{
// TODO: implement
return new character();
}
}