com.hcl.domino.jna.internal.structs.NotesResultsInfoStruct Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-jna-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * Licensed under the  Apache License, Version 2.0  (the "License").  You may
 * not use this file except in compliance with the License.  You may obtain a
 * copy of the License at .
 *
 * Unless  required  by applicable  law or  agreed  to  in writing,  software
 * distributed under the License is distributed on an  "AS IS" BASIS, WITHOUT
 * WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the  specific language  governing permissions  and limitations
 * under the License.
 * ==========================================================================
 */
package com.hcl.domino.jna.internal.structs;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Arrays;
import java.util.List;

import com.hcl.domino.misc.NotesConstants;
import com.sun.jna.Pointer;
import com.sun.jna.Structure;
/**
 * This file was autogenerated by JNAerator,

 * a tool written by Olivier Chafik that uses a few opensource projects..

 * For help, please visit NativeLibs4Java , Rococoa, or JNA.
 */
public class NotesResultsInfoStruct extends BaseStructure {
	/**
	 * used to associate column names, for federated and field formula override

	 * C type : char[MAX_CMD_VALLEN]
	 */
	public byte[] name = new byte[NotesConstants.MAX_CMD_VALLEN];
	/**
	 * IDTable handle

	 * C type : DHANDLE
	 */
	public int hResults;
	/**
	 * refers to override formulas to build output

	 * C type : char[MAX_CMD_VALLEN]
	 */
	public byte[] formula_list_name = new byte[NotesConstants.MAX_CMD_VALLEN];
	/**
	 * Path to open the database to pull data, given the IDTable

	 * C type : char[MAXPATH]
	 */
	public byte[] dbPath = new byte[NotesConstants.MAXPATH];
	/**
	 * Returned for each DB in JSON and summary streams

	 * C type : char[NotesConstants.MAXSPRINTF/8+1]
	 */
	public byte[] replicaID = new byte[NotesConstants.MAXSPRINTF/8+1];
	/**
	 * TIMEDATE of LastModified when results were produced (to eliminate any changed documents)

	 * C type : TIMEDATE
	 */
	public NotesTimeDateStruct resultsTime;
	/**
	 * if the results came from DQL, query to resolve changed documents

	 * C type : MEMHANDLE
	 */
	public int hDQLQuery;
	/**
	 * The associated DQL argument list

	 * C type : MEMHANDLE
	 */
	public int hDQLQargList;
	/** The flags associated with the DQL query */
	public int dwDQLFlags;
	
	public NotesResultsInfoStruct() {
		super();
	}

	@Override
	protected int getOverrideAlignment() {
		return Structure.ALIGN_DEFAULT;
	}

	public static NotesResultsInfoStruct newInstance() {
		return AccessController.doPrivileged((PrivilegedAction) () -> {
			return new NotesResultsInfoStruct();
		});
	}

	@SuppressWarnings("nls")
  @Override
  protected List getFieldOrder() {
		return Arrays.asList("name", "hResults", "formula_list_name", "dbPath", "replicaID", "resultsTime", "hDQLQuery", "hDQLQargList", "dwDQLFlags");
	}
	
	/**
	 * @param name used to associate column names, for federated and field formula override

	 * C type : char[1]

	 * @param hResults IDTable handle

	 * C type : DHANDLE

	 * @param formula_list_name refers to override formulas to build output

	 * C type : char[2]

	 * @param dbPath Path to open the database to pull data, given the IDTable

	 * C type : char[MAXPATH]

	 * @param replicaID Returned for each DB in JSON and summary streams

	 * C type : char[3]

	 * @param resultsTime TIMEDATE of LastModified when results were produced (to eliminate any changed documents)

	 * C type : TIMEDATE

	 * @param hDQLQuery if the results came from DQL, query to resolve changed documents

	 * C type : MEMHANDLE

	 * @param hDQLQargList The associated DQL argument list

	 * C type : MEMHANDLE

	 * @param dwDQLFlags The flags associated with the DQL query
	 */
	public NotesResultsInfoStruct(byte name[], int hResults, byte formula_list_name[], byte dbPath[], byte replicaID[],
			NotesTimeDateStruct resultsTime, int hDQLQuery, int hDQLQargList, int dwDQLFlags) {
		super();
		if ((name.length != this.name.length)) 
			throw new IllegalArgumentException("Wrong array size !");
		this.name = name;
		this.hResults = hResults;
		if ((formula_list_name.length != this.formula_list_name.length)) 
			throw new IllegalArgumentException("Wrong array size !");
		this.formula_list_name = formula_list_name;
		if ((dbPath.length != this.dbPath.length)) 
			throw new IllegalArgumentException("Wrong array size !");
		this.dbPath = dbPath;
		if ((replicaID.length != this.replicaID.length)) 
			throw new IllegalArgumentException("Wrong array size !");
		this.replicaID = replicaID;
		this.resultsTime = resultsTime;
		this.hDQLQuery = hDQLQuery;
		this.hDQLQargList = hDQLQargList;
		this.dwDQLFlags = dwDQLFlags;
	}
	
	public NotesResultsInfoStruct(Pointer peer) {
		super(peer);
	}
	
	public static NotesResultsInfoStruct newInstance(Pointer peer) {
		return AccessController.doPrivileged((PrivilegedAction) () -> {
			return new NotesResultsInfoStruct(peer);
		});
	}

	public static NotesResultsInfoStruct.ByReference newInstanceByReference() {
		return AccessController.doPrivileged((PrivilegedAction) () -> {
			return new NotesResultsInfoStruct.ByReference();
		});
	}

	public static class ByReference extends NotesResultsInfoStruct implements Structure.ByReference {
		
	};
	
	public static class ByValue extends NotesResultsInfoStruct implements Structure.ByValue {
		
	};
}