Package com.longbridge.sharelist

Class SharelistContext

java.lang.Object

com.longbridge.sharelist.SharelistContext

All Implemented Interfaces:

AutoCloseable

public class SharelistContext
extends Object
implements AutoCloseable

Community sharelist management context.

Constructor Summary

Constructors

Constructor	Description
SharelistContext()

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	addSecurities(long id, String[] symbols)	Add securities to a sharelist.
void	close()
static SharelistContext	create(Config config)	Create a SharelistContext object.
CompletableFuture<Void>	create(CreateSharelistOptions opts)	Create a new sharelist.
CompletableFuture<Void>	delete(long id)	Delete a sharelist.
CompletableFuture<SharelistDetail>	detail(long id)	Get sharelist detail including its constituent securities.
CompletableFuture<SharelistList>	list(int count)	List the user's own and subscribed sharelists.
CompletableFuture<SharelistList>	popular(int count)	Get popular sharelists.
CompletableFuture<Void>	removeSecurities(long id, String[] symbols)	Remove securities from a sharelist.
CompletableFuture<Void>	sortSecurities(long id, String[] symbols)	Reorder securities in a sharelist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SharelistContext

public SharelistContext()

Method Detail

create

public static SharelistContext create(Config config)

Create a SharelistContext object.

Parameters:

config - Config object

Returns:

A new SharelistContext instance

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

list

public CompletableFuture<SharelistList> list(int count)
                                      throws OpenApiException

List the user's own and subscribed sharelists.

Parameters:

count - Maximum number of sharelists to return

Returns:

A Future resolving to the sharelist collection

Throws:

OpenApiException - If an error occurs

detail

public CompletableFuture<SharelistDetail> detail(long id)
                                          throws OpenApiException

Get sharelist detail including its constituent securities.

Parameters:

id - Sharelist ID

Returns:

A Future resolving to the sharelist detail

Throws:

OpenApiException - If an error occurs

popular

public CompletableFuture<SharelistList> popular(int count)
                                         throws OpenApiException

Get popular sharelists.

Parameters:

count - Maximum number of sharelists to return

Returns:

A Future resolving to the popular sharelist collection

Throws:

OpenApiException - If an error occurs

create

public CompletableFuture<Void> create(CreateSharelistOptions opts)
                               throws OpenApiException

Create a new sharelist.

Parameters:

opts - Options containing the name and optional description

Returns:

A Future resolving to the newly created sharelist detail

Throws:

OpenApiException - If an error occurs

addSecurities

public CompletableFuture<Void> addSecurities(long id,
                                             String[] symbols)
                                      throws OpenApiException

Add securities to a sharelist.

Parameters:

id - Sharelist ID

symbols - Array of security symbols to add

Returns:

A Future that completes when the securities have been added

Throws:

OpenApiException - If an error occurs

delete

public CompletableFuture<Void> delete(long id)
                               throws OpenApiException

Delete a sharelist.

Parameters:

id - Sharelist ID

Returns:

A Future that completes when the sharelist has been deleted

Throws:

OpenApiException - If an error occurs

removeSecurities

public CompletableFuture<Void> removeSecurities(long id,
                                                String[] symbols)
                                         throws OpenApiException

Remove securities from a sharelist.

Parameters:

id - Sharelist ID

symbols - Array of security symbols to remove

Returns:

A Future that completes when the securities have been removed

Throws:

OpenApiException - If an error occurs

sortSecurities

public CompletableFuture<Void> sortSecurities(long id,
                                              String[] symbols)
                                       throws OpenApiException

Reorder securities in a sharelist.

Parameters:

id - Sharelist ID

symbols - Array of security symbols in the desired order

Returns:

A Future that completes when the securities have been reordered

Throws:

OpenApiException - If an error occurs