BufferCollection.java
/*
** Module : BufferCollection.java
** Abstract : Interface for a collection of buffers (DATASET and QUERY).
**
** Copyright (c) 2019-2021, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 OM 20190403 Created initial version.
** 002 OM 20210219 Switch from integer to int64 parameters.
*/
/*
** 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.persist;
import com.goldencode.p2j.util.*;
/**
* A collection of buffers. Expose methods and attributes for adding one or more buffers and
* retrieve the number of buffers in collection or a buffer based on its name or index id.
*/
public interface BufferCollection
{
/**
* Conversion of {@code NUM-BUFFERS()} method ({@code KW_NUM_BUFF}).
*
* @return the number of buffers in a query or {@code DataSet} object.
*/
@LegacyAttribute(name = "NUM-BUFFERS")
public integer numBuffers();
/**
* Adds one new buffer to a query object or dynamic {@code DataSet} object, without affecting
* the other buffers, if any. Use the {@code SET-BUFFERS()} method to remove all prior buffers
* and set all buffers for the object at the same time.
*
* @param bufHandle
* A buffer handle to add.
*
* @return {@code true} on success.
*/
@LegacyMethod(name = "ADD-BUFFER")
public logical addBuffer(handle bufHandle);
/**
* Adds one new buffer to a query object or dynamic {@code DataSet} object, without affecting
* the other buffers, if any. Use the {@code SET-BUFFERS()} method to remove all prior buffers
* and set all buffers for the object at the same time.
*
* @param buf
* A buffer to add.
*
* @return {@code true} on success.
*/
@LegacyMethod(name = "ADD-BUFFER")
public logical addBuffer(Buffer buf);
/**
* Adds one new buffer to a query object or dynamic {@code DataSet} object, without affecting
* the other buffers, if any. Use the {@code SET-BUFFERS()} method to remove all prior buffers
* and set all buffers for the object at the same time.
*
* @param bufName
* Legacy buffer name to add.
*
* @return {@code true} on success.
*/
@LegacyMethod(name = "ADD-BUFFER")
public default logical addBuffer(String bufName)
{
UnimplementedFeature.missing("ADD-BUFFER method not implemented");
return new logical();
}
/**
* Adds one new buffer to a query object or dynamic {@code DataSet} object, without affecting
* the other buffers, if any. Use the {@code SET-BUFFERS()} method to remove all prior buffers
* and set all buffers for the object at the same time.
*
* @param bufName
* Legacy buffer name to add.
*
* @return {@code true} on success.
*/
@LegacyMethod(name = "ADD-BUFFER")
public default logical addBuffer(character bufName)
{
UnimplementedFeature.missing("ADD-BUFFER method not implemented");
return new logical();
}
/**
* Conversion of {@code GET-BUFFER-HANDLE()} method ({@code KW_GET_BUFH}). Returns a handle of
* the first buffer of a query or {@code DataSet} object.
*
* @return requested buffer handle
*/
@LegacyMethod(name = "GET-BUFFER-HANDLE")
public handle bufferHandle();
/**
* Conversion of {@code GET-BUFFER-HANDLE()} method ({@code KW_GET_BUFH}). Returns a handle of
* a particular buffer of a query object.
*
* @param bufferName
* A CHARACTER expression that evaluates to the name of a buffer in the query or
* {@code DataSet} object.
*
* @return buffer handle
*/
@LegacyMethod(name = "GET-BUFFER-HANDLE")
public handle bufferHandle(String bufferName);
/**
* Conversion of {@code GET-BUFFER-HANDLE()} method ({@code KW_GET_BUFH}). Returns a handle of
* a particular buffer of a query object.
*
* @param bufferName
* A CHARACTER expression that evaluates to the name of a buffer in the query or
* {@code DataSet} object.
*
* @return buffer handle
*/
@LegacyMethod(name = "GET-BUFFER-HANDLE")
public handle bufferHandle(character bufferName);
/**
* Conversion of {@code GET-BUFFER-HANDLE()} method ({@code KW_GET_BUFH}). Returns a handle of
* a particular buffer of a query object.
*
* @param bufferSequenceNumber
* An INTEGER that represents the sequence number of the desired buffer.
*
* @return buffer handle
*/
@LegacyMethod(name = "GET-BUFFER-HANDLE")
public handle bufferHandle(int bufferSequenceNumber);
/**
* Conversion of {@code GET-BUFFER-HANDLE()} method ({@code KW_GET_BUFH}). Returns a handle of
* a particular buffer of a query object.
*
* @param bufferSequenceNumber
* An INTEGER that represents the sequence number of the desired buffer.
*
* @return buffer handle
*/
@LegacyMethod(name = "GET-BUFFER-HANDLE")
public handle bufferHandle(int64 bufferSequenceNumber);
/**
* Sets buffers for the query. Any buffers previously added or set are removed. Use the
* {@code addBuffer()} method to add one buffer to the object, without affecting the other
* buffers, if any. This method is the equivalent of {@code SET-BUFFERS()} method from 4GL.
*
* @param hBuffers
* Variable argument list of buffer handles to be set. In 4GL, the maximum number of
* buffers per query is 18.
*
* @return {@code true} on success.
*/
@LegacyMethod(name = "SET-BUFFERS")
public logical setBuffers(handle... hBuffers);
/**
* Sets buffers for the query. Any buffers previously added or set are removed. Use the
* {@code addBuffer()} method to add one buffer to the object, without affecting the other
* buffers, if any. This method is the equivalent of {@code SET-BUFFERS()} method from 4GL.
*
* @param bufs
* Variable argument list of Buffer to be set. In 4GL, the maximum number of buffers
* per query is 18.
*
* @return {@code true} on success.
*/
@LegacyMethod(name = "SET-BUFFERS")
public logical setBuffers(Buffer... bufs);
/**
* Sets buffers for the query. Any buffers previously added or set are removed. Use the
* {@code addBuffer()} method to add one buffer to the object, without affecting the other
* buffers, if any. This method is the equivalent of {@code SET-BUFFERS()} method from 4GL.
*
* @param bufs
* Variable argument list of Buffer to be set, a mixed list of {@link Buffer},
* {@link handle} or {@link character} instances.
*
* @return {@code true} on success
*/
@LegacyMethod(name = "SET-BUFFERS")
public default logical setBuffers(Object... bufs)
{
// this can be a mixed list of character, Buffer and handle instances.
UnimplementedFeature.todo("SET-BUFFERS(char, handle, ...) is not implemented");
return new logical();
}
}