com.viaoa.datasource.rest.RemoteRestClientInterface Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oa-core Show documentation
Object Automation library
The newest version!
/*  Copyright 1999 Vince Via [email protected]
    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 http://www.apache.org/licenses/LICENSE-2.0
    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.viaoa.datasource.rest;

import com.viaoa.object.OAObject;
import com.viaoa.object.OAObjectKey;
import com.viaoa.remote.rest.annotation.OARestClass;
import com.viaoa.remote.rest.annotation.OARestMethod;
import com.viaoa.remote.rest.annotation.OARestMethod.MethodType;
import com.viaoa.sync.remote.RemoteClientInterface;

/**
 * REST Client remote methods that will use the same named msg queue as RemoteSync, when set up (bind) on the server. This is so that
 * changes can be ordered and instances (clients/server) will stay in sync.
 *
 * @author vvia
 */
@OARestClass()
public interface RemoteRestClientInterface extends RemoteClientInterface {

	@OARestMethod(methodType = MethodType.OARemote)
	OAObject createCopy(Class objectClass, OAObjectKey objectKey, String[] excludeProperties);

	@OARestMethod(methodType = MethodType.OARemote)
	Object getDetail(int id, Class masterClass, OAObjectKey masterObjectKey, String property, boolean bForHubMerger);

	@OARestMethod(methodType = MethodType.OARemote)
	Object getDetail(int id, Class masterClass, OAObjectKey masterObjectKey,
			String property, String[] masterProps, OAObjectKey[] siblingKeys, boolean bForHubMerger);

	// dont put in queue, but have it returned on vsocket for queued messages
	//     All of the other methods are put in queue to be processed and have the return value set.
	//@OARemoteMethod(returnOnQueueSocket = true)
	@OARestMethod(methodType = MethodType.OARemote)
	Object getDetailNow(int id, Class masterClass, OAObjectKey masterObjectKey,
			String property, String[] masterProps, OAObjectKey[] siblingKeys, boolean bForHubMerger);

	@OARestMethod(methodType = MethodType.OARemote)
	Object datasource(int command, Object[] objects);

	//@OARemoteMethod(noReturnValue = true)
	@OARestMethod(methodType = MethodType.OARemote)
	void datasourceNoReturn(int command, Object[] objects);

	@OARestMethod(methodType = MethodType.OARemote)
	boolean delete(Class objectClass, OAObjectKey objectKey);

	@OARestMethod(methodType = MethodType.OARemote)
	boolean deleteAll(Class objectClass, OAObjectKey objectKey, String hubPropertyName);
}